001    package org.apache.commons.digester3.binder;
002    
003    /*
004     * Licensed to the Apache Software Foundation (ASF) under one
005     * or more contributor license agreements.  See the NOTICE file
006     * distributed with this work for additional information
007     * regarding copyright ownership.  The ASF licenses this file
008     * to you under the Apache License, Version 2.0 (the
009     * "License"); you may not use this file except in compliance
010     * with the License.  You may obtain a copy of the License at
011     *
012     *   http://www.apache.org/licenses/LICENSE-2.0
013     *
014     * Unless required by applicable law or agreed to in writing,
015     * software distributed under the License is distributed on an
016     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017     * KIND, either express or implied.  See the License for the
018     * specific language governing permissions and limitations
019     * under the License.
020     */
021    
022    import org.apache.commons.digester3.PathCallParamRule;
023    
024    /**
025     * Builder chained when invoking {@link LinkedRuleBuilder#callParamPath()}.
026     *
027     * @since 3.0
028     */
029    public final class PathCallParamBuilder
030        extends AbstractBackToLinkedRuleBuilder<PathCallParamRule>
031    {
032    
033        private int paramIndex = 0;
034    
035        PathCallParamBuilder( String keyPattern, String namespaceURI, RulesBinder mainBinder,
036                              LinkedRuleBuilder mainBuilder )
037        {
038            super( keyPattern, namespaceURI, mainBinder, mainBuilder );
039        }
040    
041        /**
042         * Sets the zero-relative parameter number.
043         *
044         * @param paramIndex The zero-relative parameter number
045         * @return this builder instance
046         */
047        public PathCallParamBuilder ofIndex( int paramIndex )
048        {
049            if ( paramIndex < 0 )
050            {
051                reportError( "callParamPath().ofIndex( int )", "negative index argument not allowed" );
052            }
053    
054            this.paramIndex = paramIndex;
055            return this;
056        }
057    
058        /**
059         * {@inheritDoc}
060         */
061        @Override
062        protected PathCallParamRule createRule()
063        {
064            return new PathCallParamRule( paramIndex );
065        }
066    
067    }