/* $Id: SetProperty.java 992750 2010-09-05 09:54:37Z simonetripodi $
*
* 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.
*/
package org.apache.commons.digester.annotations.rules;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.apache.commons.digester.SetPropertiesRule;
import org.apache.commons.digester.annotations.DigesterRule;
import org.apache.commons.digester.annotations.DigesterRuleList;
import org.apache.commons.digester.annotations.handlers.SetPropertiesLoaderHandler;
import org.apache.commons.digester.annotations.providers.SetPropertiesRuleProvider;
Fields annotated with SetProperty
will be bound with SetPropertiesRule
digester rule. See Also: Since: 2.1
/**
* Fields annotated with {@code SetProperty} will be bound
* with {@code SetPropertiesRule} digester rule.
*
* @see org.apache.commons.digester.Digester#addSetProperties(String,String[],String[])
* @since 2.1
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
@DigesterRule(
reflectsRule = SetPropertiesRule.class,
providedBy = SetPropertiesRuleProvider.class,
handledBy = SetPropertiesLoaderHandler.class
)
public @interface SetProperty {
The element matching pattern.
Returns: the element matching pattern.
/**
* The element matching pattern.
*
* @return the element matching pattern.
*/
String pattern();
The overridden parameter.
Returns: the overridden parameter.
/**
* The overridden parameter.
*
* @return the overridden parameter.
*/
String attributeName() default "";
Defines several @SetProperty
annotations on the same element. See Also:
/**
* Defines several {@code @SetProperty} annotations on the same element.
*
* @see SetProperty
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@DigesterRuleList
@interface List {
SetProperty[] value();
}
}