001/* $Id: ObjectCreate.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 */
018package org.apache.commons.digester.annotations.rules;
019
020import java.lang.annotation.Documented;
021import java.lang.annotation.ElementType;
022import java.lang.annotation.Retention;
023import java.lang.annotation.RetentionPolicy;
024import java.lang.annotation.Target;
025
026import org.apache.commons.digester.ObjectCreateRule;
027import org.apache.commons.digester.annotations.CreationRule;
028import org.apache.commons.digester.annotations.DigesterRule;
029import org.apache.commons.digester.annotations.DigesterRuleList;
030import org.apache.commons.digester.annotations.providers.ObjectCreateRuleProvider;
031
032/**
033 * Classes annotated with {@code ObjectCreate} will be bound with
034 * {@code ObjectCreateRule} digester rule.
035 *
036 * @see org.apache.commons.digester.Digester#addObjectCreate(String,Class)
037 * @since 2.1
038 */
039@Documented
040@Retention(RetentionPolicy.RUNTIME)
041@Target(ElementType.TYPE)
042@CreationRule
043@DigesterRule(
044        reflectsRule = ObjectCreateRule.class,
045        providedBy = ObjectCreateRuleProvider.class
046)
047public @interface ObjectCreate {
048
049    /**
050     * The element matching pattern.
051     *
052     * @return the element matching pattern.
053     */
054    String pattern();
055
056    /**
057     * Defines several {@code @ObjectCreate} annotations on the same element.
058     *
059     * @see ObjectCreate
060     */
061    @Documented
062    @Retention(RetentionPolicy.RUNTIME)
063    @Target(ElementType.TYPE)
064    @DigesterRuleList
065    @interface List {
066        ObjectCreate[] value();
067    }
068
069}