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 java.util.Map;
23  
24  /**
25   * @since 3.2
26   * @param <B> the parent builder type.
27   */
28  public final class AddAliasBuilder<B>
29  {
30  
31      private final B parentBuilder;
32  
33      private final Map<String, String> aliases;
34  
35      private final String alias;
36  
37      AddAliasBuilder( B parentBuilder, Map<String, String> aliases, String alias )
38      {
39          this.parentBuilder = parentBuilder;
40          this.aliases = aliases;
41          this.alias = alias;
42      }
43  
44      /**
45       * Allows expressing the input property name alias.
46       *
47       * @param propertyName The java bean property to be assigned the value
48       * @return the parent builder to chain.
49       */
50      public B forProperty( /*@Nullable*/ String propertyName )
51      {
52          if ( alias != null )
53          {
54              aliases.put( alias, propertyName );
55          }
56          return parentBuilder;
57      }
58  
59  }