com.feilong.lib.digester3.binder.NestedPropertiesBuilder Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of feilong Show documentation
feilong is a suite of core and expanded libraries that include utility classes, http, excel,cvs, io classes, and much much more.
There is a newer version: 4.0.8
Show newest version
package com.feilong.lib.digester3.binder;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import java.util.HashMap;
import java.util.Map;

import com.feilong.lib.digester3.SetNestedPropertiesRule;

/**
 * Builder chained when invoking {@link LinkedRuleBuilder#setNestedProperties()}.
 *
 * @since 3.0
 */
public final class NestedPropertiesBuilder extends AbstractBackToLinkedRuleBuilder{

    private final Map elementNames              = new HashMap<>();

    private boolean                   trimData                  = true;

    private boolean                   allowUnknownChildElements = false;

    NestedPropertiesBuilder(String keyPattern, String namespaceURI, RulesBinder mainBinder, LinkedRuleBuilder mainBuilder){
        super(keyPattern, namespaceURI, mainBinder, mainBuilder);
    }

    /**
     * Allows ignore a matching element.
     *
     * @param elementName
     *            The child xml element to be ignored
     * @return this builder instance
     */
    public NestedPropertiesBuilder ignoreElement(String elementName){
        if (elementName == null){
            reportError("setNestedProperties().ignoreElement( String )", "empty 'elementName' not allowed");
        }
        return addAlias(elementName).forProperty(null);
    }

    /**
     * Allows element2property mapping to be overridden.
     *
     * @param elementName
     *            The child xml element to match
     * @param propertyName
     *            The java bean property to be assigned the value
     * @return this builder instance
     * @deprecated
     */
    @Deprecated
    public NestedPropertiesBuilder addAlias(String elementName,String propertyName){
        return addAlias(elementName).forProperty(propertyName);
    }

    /**
     * Allows element2property mapping to be overridden.
     *
     * @param elementName
     *            The child xml element to match
     * @return the property alias builder
     * @since 3.2
     */
    public AddAliasBuilder addAlias(String elementName){
        if (elementName == null){
            reportError("setProperties().addAlias( String )", "empty 'elementName' not allowed");
        }
        return new AddAliasBuilder<>(this, elementNames, elementName);
    }

    /**
     * When set to true, any text within child elements will have leading
     * and trailing whitespace removed before assignment to the target
     * object.
     *
     * @param trimData
     *            Flag to set any text within child elements will have leading
     *            and trailing whitespace removed
     * @return this builder instance
     */
    public NestedPropertiesBuilder trimData(boolean trimData){
        this.trimData = trimData;
        return this;
    }

    /**
     * Determines whether an error is reported when a nested element is encountered for which there is no corresponding
     * property-setter method.
     *
     * @param allowUnknownChildElements
     *            flag to ignore any child element for which there is no corresponding
     *            object property
     * @return this builder instance
     */
    public NestedPropertiesBuilder allowUnknownChildElements(boolean allowUnknownChildElements){
        this.allowUnknownChildElements = allowUnknownChildElements;
        return this;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    protected SetNestedPropertiesRule createRule(){
        SetNestedPropertiesRule rule = new SetNestedPropertiesRule(elementNames);
        rule.setTrimData(trimData);
        rule.setAllowUnknownChildElements(allowUnknownChildElements);
        return rule;
    }

}