View Javadoc

1   package org.apache.commons.digester3.binder;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.apache.commons.digester3.PathCallParamRule;
23  
24  /**
25   * Builder chained when invoking {@link LinkedRuleBuilder#callParamPath()}.
26   *
27   * @since 3.0
28   */
29  public final class PathCallParamBuilder
30      extends AbstractBackToLinkedRuleBuilder<PathCallParamRule>
31  {
32  
33      private int paramIndex = 0;
34  
35      PathCallParamBuilder( String keyPattern, String namespaceURI, RulesBinder mainBinder,
36                            LinkedRuleBuilder mainBuilder )
37      {
38          super( keyPattern, namespaceURI, mainBinder, mainBuilder );
39      }
40  
41      /**
42       * Sets the zero-relative parameter number.
43       *
44       * @param paramIndex The zero-relative parameter number
45       * @return this builder instance
46       */
47      public PathCallParamBuilder ofIndex( int paramIndex )
48      {
49          if ( paramIndex < 0 )
50          {
51              reportError( "callParamPath().ofIndex( int )", "negative index argument not allowed" );
52          }
53  
54          this.paramIndex = paramIndex;
55          return this;
56      }
57  
58      /**
59       * {@inheritDoc}
60       */
61      @Override
62      protected PathCallParamRule createRule()
63      {
64          return new PathCallParamRule( paramIndex );
65      }
66  
67  }