org.apache.commons.digester3.binder.SetPropertyBuilder Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of commons-digester3 Show documentation

The Apache Commons Digester package lets you configure an XML to Java object mapping module which triggers certain actions called rules whenever a particular pattern of nested XML elements is recognized.

The newest version!

package org.apache.commons.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 static java.lang.String.format;

import org.apache.commons.digester3.SetPropertyRule;

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

    private final String attributePropertyName;

    private String valueAttributeName;

    SetPropertyBuilder( String keyPattern, String namespaceURI, RulesBinder mainBinder, LinkedRuleBuilder mainBuilder,
                        String attributePropertyName )
    {
        super( keyPattern, namespaceURI, mainBinder, mainBuilder );
        this.attributePropertyName = attributePropertyName;
    }

    /**
     * Set the name of the attribute that will contain the value to which the property should be set.
     *
     * @param valueAttributeName Name of the attribute that will contain the value to which the property should be set.
     * @return this builder instance
     */
    public SetPropertyBuilder extractingValueFromAttribute( String valueAttributeName )
    {
        if ( attributePropertyName == null || attributePropertyName.length() == 0 )
        {
            reportError( format( "setProperty(\"%s\").extractingValueFromAttribute(String)}", attributePropertyName ),
                         "empty 'valueAttributeName' not allowed" );
        }

        this.valueAttributeName = valueAttributeName;
        return this;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    protected SetPropertyRule createRule()
    {
        return new SetPropertyRule( attributePropertyName, valueAttributeName );
    }

}