/* $Id: FactoryCreate.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.AbstractObjectCreationFactory;
import org.apache.commons.digester.FactoryCreateRule;
import org.apache.commons.digester.annotations.CreationRule;
import org.apache.commons.digester.annotations.DigesterRule;
import org.apache.commons.digester.annotations.DigesterRuleList;
import org.apache.commons.digester.annotations.providers.FactoryCreateRuleProvider;

Classes annotated with FactoryCreate will be bound with FactoryCreateRule digester rule. 
See Also:
Digester.addFactoryCreate(String, ObjectCreationFactory, boolean)
Since:
2.1/**
 * Classes annotated with {@code FactoryCreate} will be bound with
 * {@code FactoryCreateRule} digester rule.
 *
 * @see org.apache.commons.digester.Digester#addFactoryCreate(String,org.apache.commons.digester.ObjectCreationFactory,boolean)
 * @since 2.1
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@CreationRule
@DigesterRule(
        reflectsRule = FactoryCreateRule.class,
        providedBy = FactoryCreateRuleProvider.class
)
public @interface FactoryCreate {

    
The Java class of the object creation factory class
Returns:
the Java class of the object creation factory class./**
     * The Java class of the object creation factory class
     *
     * @return the Java class of the object creation factory class.
     */
    Class<? extends AbstractObjectCreationFactory> factoryClass();

    
The element matching pattern.
Returns:
the element matching pattern./**
     * The element matching pattern.
     *
     * @return the element matching pattern.
     */
    String pattern();

    
When true any exceptions thrown during object creation will be ignored.
Returns:
when true any exceptions thrown during object creation will be
        ignored./**
     * When true any exceptions thrown during object creation will be ignored.
     *
     * @return when true any exceptions thrown during object creation will be
     *         ignored.
     */
    boolean ignoreCreateExceptions() default false;

    
Defines several @FactoryCreate annotations on the same element. 
See Also:
FactoryCreate/**
     * Defines several {@code @FactoryCreate} annotations on the same element.
     *
     * @see FactoryCreate
     */
    @Documented
    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.TYPE)
    @DigesterRuleList
    @interface List {
        FactoryCreate[] value();
    }

}