001    /* $Id: SetProperty.java 992750 2010-09-05 09:54:37Z simonetripodi $
002     *
003     * Licensed to the Apache Software Foundation (ASF) under one or more
004     * contributor license agreements.  See the NOTICE file distributed with
005     * this work for additional information regarding copyright ownership.
006     * The ASF licenses this file to You under the Apache License, Version 2.0
007     * (the "License"); you may not use this file except in compliance with
008     * the License.  You may obtain a copy of the License at
009     *
010     *      http://www.apache.org/licenses/LICENSE-2.0
011     *
012     * Unless required by applicable law or agreed to in writing, software
013     * distributed under the License is distributed on an "AS IS" BASIS,
014     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015     * See the License for the specific language governing permissions and
016     * limitations under the License.
017     */
018    package org.apache.commons.digester.annotations.rules;
019    
020    import java.lang.annotation.Documented;
021    import java.lang.annotation.ElementType;
022    import java.lang.annotation.Retention;
023    import java.lang.annotation.RetentionPolicy;
024    import java.lang.annotation.Target;
025    
026    import org.apache.commons.digester.SetPropertiesRule;
027    import org.apache.commons.digester.annotations.DigesterRule;
028    import org.apache.commons.digester.annotations.DigesterRuleList;
029    import org.apache.commons.digester.annotations.handlers.SetPropertiesLoaderHandler;
030    import org.apache.commons.digester.annotations.providers.SetPropertiesRuleProvider;
031    
032    /**
033     * Fields annotated with {@code SetProperty} will be bound
034     * with {@code SetPropertiesRule} digester rule.
035     *
036     * @see org.apache.commons.digester.Digester#addSetProperties(String,String[],String[])
037     * @since 2.1
038     */
039    @Documented
040    @Retention(RetentionPolicy.RUNTIME)
041    @Target(ElementType.FIELD)
042    @DigesterRule(
043            reflectsRule = SetPropertiesRule.class,
044            providedBy = SetPropertiesRuleProvider.class,
045            handledBy = SetPropertiesLoaderHandler.class
046    )
047    public @interface SetProperty {
048    
049        /**
050         * The element matching pattern.
051         *
052         * @return the element matching pattern.
053         */
054        String pattern();
055    
056        /**
057         * The overridden parameter.
058         *
059         * @return the overridden parameter.
060         */
061        String attributeName() default "";
062    
063        /**
064         * Defines several {@code @SetProperty} annotations on the same element.
065         *
066         * @see SetProperty
067         */
068        @Documented
069        @Retention(RetentionPolicy.RUNTIME)
070        @Target(ElementType.TYPE)
071        @DigesterRuleList
072        @interface List {
073            SetProperty[] value();
074        }
075    
076    }