001package 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
022import java.util.Map;
023
024/**
025 * @since 3.2
026 * @param <B> the parent builder type.
027 */
028public final class AddAliasBuilder<B>
029{
030
031    private final B parentBuilder;
032
033    private final Map<String, String> aliases;
034
035    private final String alias;
036
037    AddAliasBuilder( B parentBuilder, Map<String, String> aliases, String alias )
038    {
039        this.parentBuilder = parentBuilder;
040        this.aliases = aliases;
041        this.alias = alias;
042    }
043
044    /**
045     * Allows expressing the input property name alias.
046     *
047     * @param propertyName The java bean property to be assigned the value
048     * @return the parent builder to chain.
049     */
050    public B forProperty( /*@Nullable*/ String propertyName )
051    {
052        if ( alias != null )
053        {
054            aliases.put( alias, propertyName );
055        }
056        return parentBuilder;
057    }
058
059}