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 org.apache.commons.digester3.BeanPropertySetterRule;
023    
024    /**
025     * Builder chained when invoking {@link LinkedRuleBuilder#setBeanProperty()}.
026     */
027    public final class BeanPropertySetterBuilder
028        extends AbstractBackToLinkedRuleBuilder<BeanPropertySetterRule>
029    {
030    
031        private String propertyName;
032    
033        private String attribute;
034    
035        BeanPropertySetterBuilder( String keyPattern, String namespaceURI, RulesBinder mainBinder,
036                                   LinkedRuleBuilder mainBuilder )
037        {
038            super( keyPattern, namespaceURI, mainBinder, mainBuilder );
039        }
040    
041        /**
042         * Sets the name of property to set.
043         *
044         * @param propertyName The name of property to set
045         * @return this builder instance
046         */
047        public BeanPropertySetterBuilder withName( /* @Nullable */String propertyName )
048        {
049            this.propertyName = propertyName;
050            return this;
051        }
052    
053        /**
054         * Sets the attribute name from which the property name has to be extracted.
055         *
056         * @param attribute The attribute name from which extracting the name of property to set
057         * @return this builder instance
058         */
059        public BeanPropertySetterBuilder extractPropertyNameFromAttribute( String attribute )
060        {
061            if ( attribute == null )
062            {
063                reportError( "setBeanProperty().extractPropertyNameFromAttribute( String )",
064                             "Attribute name can not be null" );
065            }
066            this.attribute = attribute;
067            return this;
068        }
069    
070        /**
071         * {@inheritDoc}
072         */
073        @Override
074        protected BeanPropertySetterRule createRule()
075        {
076            BeanPropertySetterRule rule = new BeanPropertySetterRule( propertyName );
077            rule.setPropertyNameFromAttribute( attribute );
078            return rule;
079        }
080    
081    }