svn commit: r896458 - /commons/sandbox/at-digester/trunk/src/main/java/org/apache/commons/digester/annotations/FactoryCreate.java

[si...@apache.org]

Author: simonetripodi
Date: Wed Jan  6 14:44:30 2010
New Revision: 896458

URL: http://svn.apache.org/viewvc?rev=896458&view=rev
Log:
Initial checkin for the FactoryCreate annotation

Added:
    commons/sandbox/at-digester/trunk/src/main/java/org/apache/commons/digester/annotations/FactoryCreate.java   (with props)

Added: commons/sandbox/at-digester/trunk/src/main/java/org/apache/commons/digester/annotations/FactoryCreate.java
URL: http://svn.apache.org/viewvc/commons/sandbox/at-digester/trunk/src/main/java/org/apache/commons/digester/annotations/FactoryCreate.java?rev=896458&view=auto
==============================================================================
--- commons/sandbox/at-digester/trunk/src/main/java/org/apache/commons/digester/annotations/FactoryCreate.java (added)
+++ commons/sandbox/at-digester/trunk/src/main/java/org/apache/commons/digester/annotations/FactoryCreate.java Wed Jan  6 14:44:30 2010
@@ -0,0 +1,78 @@
+/*
+ * 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;
+
+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;
+
+/**
+ * Classes annotated with {@code FactoryCreate} will be bound with
+ * {@code FactoryCreateRule} digester rule.
+ *
+ * @author Simone Tripodi
+ * @version $Id$
+ * @see {@link org.apache.commons.digester.Digester#addFactoryCreate(String, org.apache.commons.digester.ObjectCreationFactory, boolean)}
+ */
+@Documented
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.TYPE)
+@DigesterRule(
+        reflectsRule = FactoryCreateRule.class
+)
+public @interface FactoryCreate {
+
+    /**
+     * Returns Java class of the object creation factory class
+     *
+     * @return the Java class of the object creation factory class.
+     */
+    Class<? extends AbstractObjectCreationFactory> factoryClass();
+
+    /**
+     * Returns the element matching pattern.
+     *
+     * @return the element matching pattern.
+     */
+    String pattern();
+
+    /**
+     * 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 {@link FactoryCreate}
+     */
+    @Documented
+    @Retention(RetentionPolicy.RUNTIME)
+    @Target(ElementType.TYPE)
+    @interface List {
+        FactoryCreate[] value();
+    }
+
+}

Propchange: commons/sandbox/at-digester/trunk/src/main/java/org/apache/commons/digester/annotations/FactoryCreate.java
------------------------------------------------------------------------------
    svn:keywords = Date Rev Author Id