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 static java.lang.String.format;
23  
24  import org.apache.commons.digester3.SetPropertyRule;
25  
26  /**
27   * Builder chained when invoking {@link LinkedRuleBuilder#setProperty(String)}.
28   *
29   * @since 3.0
30   */
31  public final class SetPropertyBuilder
32      extends AbstractBackToLinkedRuleBuilder<SetPropertyRule>
33  {
34  
35      private final String attributePropertyName;
36  
37      private String valueAttributeName;
38  
39      SetPropertyBuilder( String keyPattern, String namespaceURI, RulesBinder mainBinder, LinkedRuleBuilder mainBuilder,
40                          String attributePropertyName )
41      {
42          super( keyPattern, namespaceURI, mainBinder, mainBuilder );
43          this.attributePropertyName = attributePropertyName;
44      }
45  
46      /**
47       * Set the name of the attribute that will contain the value to which the property should be set.
48       *
49       * @param valueAttributeName Name of the attribute that will contain the value to which the property should be set.
50       * @return this builder instance
51       */
52      public SetPropertyBuilder extractingValueFromAttribute( String valueAttributeName )
53      {
54          if ( attributePropertyName == null || attributePropertyName.length() == 0 )
55          {
56              reportError( format( "setProperty(\"%s\").extractingValueFromAttribute(String)}", attributePropertyName ),
57                           "empty 'valueAttributeName' not allowed" );
58          }
59  
60          this.valueAttributeName = valueAttributeName;
61          return this;
62      }
63  
64      /**
65       * {@inheritDoc}
66       */
67      @Override
68      protected SetPropertyRule createRule()
69      {
70          return new SetPropertyRule( attributePropertyName, valueAttributeName );
71      }
72  
73  }