001    package 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    
022    import static java.lang.String.format;
023    
024    import org.apache.commons.digester3.SetPropertyRule;
025    
026    /**
027     * Builder chained when invoking {@link LinkedRuleBuilder#setProperty(String)}.
028     *
029     * @since 3.0
030     */
031    public final class SetPropertyBuilder
032        extends AbstractBackToLinkedRuleBuilder<SetPropertyRule>
033    {
034    
035        private final String attributePropertyName;
036    
037        private String valueAttributeName;
038    
039        SetPropertyBuilder( String keyPattern, String namespaceURI, RulesBinder mainBinder, LinkedRuleBuilder mainBuilder,
040                            String attributePropertyName )
041        {
042            super( keyPattern, namespaceURI, mainBinder, mainBuilder );
043            this.attributePropertyName = attributePropertyName;
044        }
045    
046        /**
047         * Set the name of the attribute that will contain the value to which the property should be set.
048         *
049         * @param valueAttributeName Name of the attribute that will contain the value to which the property should be set.
050         * @return this builder instance
051         */
052        public SetPropertyBuilder extractingValueFromAttribute( String valueAttributeName )
053        {
054            if ( attributePropertyName == null || attributePropertyName.length() == 0 )
055            {
056                reportError( format( "setProperty(\"%s\").extractingValueFromAttribute(String)}", attributePropertyName ),
057                             "empty 'valueAttributeName' not allowed" );
058            }
059    
060            this.valueAttributeName = valueAttributeName;
061            return this;
062        }
063    
064        /**
065         * {@inheritDoc}
066         */
067        @Override
068        protected SetPropertyRule createRule()
069        {
070            return new SetPropertyRule( attributePropertyName, valueAttributeName );
071        }
072    
073    }