Author: mattsicker
Date: Mon May 26 03:56:42 2014
New Revision: 1597506
URL: http://svn.apache.org/r1597506
Log:
Add PluginVisitor interface.
Added:
logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/config/plugins/visitors/PluginVisitor.java
(with props)
Added:
logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/config/plugins/visitors/PluginVisitor.java
URL:
http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/config/plugins/visitors/PluginVisitor.java?rev=1597506&view=auto
==============================================================================
---
logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/config/plugins/visitors/PluginVisitor.java
(added)
+++
logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/config/plugins/visitors/PluginVisitor.java
Mon May 26 03:56:42 2014
@@ -0,0 +1,82 @@
+/*
+ * 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.logging.log4j.core.config.plugins.visitors;
+
+import java.lang.annotation.Annotation;
+
+import org.apache.logging.log4j.core.LogEvent;
+import org.apache.logging.log4j.core.config.Configuration;
+import org.apache.logging.log4j.core.config.Node;
+import org.apache.logging.log4j.core.lookup.StrSubstitutor;
+
+/**
+ * Visitor strategy for parsing data from a {@link Node}, doing any relevant
type conversion, and returning a
+ * parsed value for that variable. Implementations must be constructable using
the default constructor.
+ *
+ * @param <A> the Annotation type.
+ */
+public interface PluginVisitor<A extends Annotation> {
+
+ /**
+ * Sets the Annotation to be used for this. If the given Annotation is not
compatible with this class's type, then
+ * it is ignored.
+ *
+ * @param annotation the Annotation instance.
+ * @return {@code this}.
+ * @throws NullPointerException if the argument is {@code null}.
+ */
+ PluginVisitor<A> setAnnotation(Annotation annotation);
+
+ /**
+ * Sets the list of aliases to use for this visit. No aliases are
required, however.
+ *
+ * @param aliases the list of aliases to use.
+ * @return {@code this}.
+ */
+ PluginVisitor<A> setAliases(String... aliases);
+
+ /**
+ * Sets the class to convert the plugin value to on this visit. This
should correspond with a class obtained from
+ * a factory method or builder class field. Not all PluginVisitor
implementations may need this value.
+ *
+ * @param conversionType the type to convert the plugin string to (if
applicable).
+ * @return {@code this}.
+ * @throws NullPointerException if the argument is {@code null}.
+ */
+ PluginVisitor<A> setConversionType(Class<?> conversionType);
+
+ /**
+ * Sets the StrSubstitutor to use for converting raw strings before type
conversion. Generally obtained from a
+ * {@link org.apache.logging.log4j.core.config.Configuration}.
+ *
+ * @param substitutor the StrSubstitutor to use on plugin values.
+ * @return {@code this}.
+ * @throws NullPointerException if the argument is {@code null}.
+ */
+ PluginVisitor<A> setStrSubstitutor(StrSubstitutor substitutor);
+
+ /**
+ * Visits a Node to obtain a value for constructing a Plugin object.
+ *
+ * @param configuration the current Configuration.
+ * @param node the current Node corresponding to the Plugin
object being created.
+ * @param event the current LogEvent that caused this Plugin
object to be made (optional).
+ * @return the converted value to be used for Plugin creation.
+ */
+ Object visit(Configuration configuration, Node node, LogEvent event);
+}
Propchange:
logging/log4j/log4j2/trunk/log4j-core/src/main/java/org/apache/logging/log4j/core/config/plugins/visitors/PluginVisitor.java
------------------------------------------------------------------------------
svn:eol-style = native
