summaryrefslogtreecommitdiff
path: root/javax/annotation
diff options
context:
space:
mode:
Diffstat (limited to 'javax/annotation')
-rw-r--r--javax/annotation/processing/Filer.java91
-rw-r--r--javax/annotation/processing/Messager.java56
-rw-r--r--javax/annotation/processing/ProcessingEnvironment.java100
-rw-r--r--javax/annotation/processing/RoundEnvironment.java119
4 files changed, 366 insertions, 0 deletions
diff --git a/javax/annotation/processing/Filer.java b/javax/annotation/processing/Filer.java
new file mode 100644
index 000000000..4da90ca63
--- /dev/null
+++ b/javax/annotation/processing/Filer.java
@@ -0,0 +1,91 @@
+/* Filer.java -- Manages file creation for an annotation processor.
+ Copyright (C) 2012 Free Software Foundation, Inc.
+
+This file is part of GNU Classpath.
+
+GNU Classpath is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2, or (at your option)
+any later version.
+
+GNU Classpath is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with GNU Classpath; see the file COPYING. If not, write to the
+Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+02110-1301 USA.
+
+Linking this library statically or dynamically with other modules is
+making a combined work based on this library. Thus, the terms and
+conditions of the GNU General Public License cover the whole
+combination.
+
+As a special exception, the copyright holders of this library give you
+permission to link this library with independent modules to produce an
+executable, regardless of the license terms of these independent
+modules, and to copy and distribute the resulting executable under
+terms of your choice, provided that you also meet, for each linked
+independent module, the terms and conditions of the license of that
+module. An independent module is a module which is not derived from
+or based on this library. If you modify this library, you may extend
+this exception to your version of the library, but you are not
+obligated to do so. If you do not wish to do so, delete this
+exception statement from your version. */
+
+package javax.annotation.processing;
+
+/**
+ * <p>This interface supports the creation of new files by the
+ * annotation processor. Creating files via this interface means
+ * that they can be tracked by the annotation processing tool.
+ * Once the file streams are closed, the tool will automatically
+ * consider them for processing.</p>
+ * <p>Files are separated into three types: source files, class
+ * files and resource files. Two locations are defined; one
+ * for source files and one for class files (resource files
+ * may use either). Locations are specified using a relative
+ * path separated by {@code '/'} and not including the
+ * segments {@code '.'} and {@code '..'} so that they may only
+ * refer to subdirectories. A valid relative name must match
+ * the "path-rootless" rule of RFC 3986, section 3.3.</p>
+ * <p>The file creation methods take a variable number of
+ * originating elements, which can be used by the tool to
+ * handle dependency management. For example, if a
+ * file is generated due to the presence of a particular
+ * method, the element representing that method may be
+ * specified as an originating element. Whether this
+ * information is used by the tool or not is left down
+ * to the implementator.</p>
+ * <p>Each run of the annotation processing tool may only
+ * create a file with a given pathname once. Attempts
+ * to create the same file a second time will result in
+ * a {@link FilerException}. The same behaviour results
+ * from trying to overwrite the initial source files, which
+ * are classed as being created in the zeroth round of
+ * processing. The same exception will be thrown if
+ * the same name is used for both a source file and a
+ * class file.</p>
+ * <p>Processors must not knowingly attempt to overwrite
+ * files that weren't generated by themselves or a similar
+ * tool. Similarly, the user invoking the tool should
+ * not configure it so that it will end up overwriting
+ * files that weren't generated. A {@code Filer}
+ * implementation may include safeguards so as not to
+ * overwrite class files such as {@code java.lang.Object}.</p>
+ * <p>The {@link javax.lang.annotation.Generated}
+ * annotation is available to denote generated files
+ * if needed. Some of the effect of overwriting files may
+ * be achieved by using a decorator-style design
+ * pattern and either a generated superclass or a series
+ * of generated subclasses. In the latter case,
+ * the class would provide the appropriate generated
+ * subclass via the factory pattern.</p>
+ *
+ * @since 1.6
+ */
+public interface Filer
+{
+}
diff --git a/javax/annotation/processing/Messager.java b/javax/annotation/processing/Messager.java
new file mode 100644
index 000000000..97d64470e
--- /dev/null
+++ b/javax/annotation/processing/Messager.java
@@ -0,0 +1,56 @@
+/* Messager.java -- Allows an annotation processor to report messages.
+ Copyright (C) 2012 Free Software Foundation, Inc.
+
+This file is part of GNU Classpath.
+
+GNU Classpath is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2, or (at your option)
+any later version.
+
+GNU Classpath is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with GNU Classpath; see the file COPYING. If not, write to the
+Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+02110-1301 USA.
+
+Linking this library statically or dynamically with other modules is
+making a combined work based on this library. Thus, the terms and
+conditions of the GNU General Public License cover the whole
+combination.
+
+As a special exception, the copyright holders of this library give you
+permission to link this library with independent modules to produce an
+executable, regardless of the license terms of these independent
+modules, and to copy and distribute the resulting executable under
+terms of your choice, provided that you also meet, for each linked
+independent module, the terms and conditions of the license of that
+module. An independent module is a module which is not derived from
+or based on this library. If you modify this library, you may extend
+this exception to your version of the library, but you are not
+obligated to do so. If you do not wish to do so, delete this
+exception statement from your version. */
+
+package javax.annotation.processing;
+
+/**
+ * Provides a way for an annotation processor to report
+ * messages to the user. Messages may use elements,
+ * annotations and annotation values to provide a location
+ * hint, but these may be either unavailable or only
+ * approximate. Printing a message of kind
+ * {@link javax.tools.Diagnostic,Kind#ERROR} will cause
+ * an error to be raised. How the messages are displayed
+ * is left to the implementor; it may be a simple use of
+ * {@code System.out} and/or {@code System.err} or something
+ * more graphical if the application has a user interface.
+ *
+ * @since 1.6
+ */
+public interface Messager
+{
+}
diff --git a/javax/annotation/processing/ProcessingEnvironment.java b/javax/annotation/processing/ProcessingEnvironment.java
new file mode 100644
index 000000000..4373ad9da
--- /dev/null
+++ b/javax/annotation/processing/ProcessingEnvironment.java
@@ -0,0 +1,100 @@
+/* ProcessingEnvironment.java -- Links the annotation processor to the framework.
+ Copyright (C) 2012 Free Software Foundation, Inc.
+
+This file is part of GNU Classpath.
+
+GNU Classpath is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2, or (at your option)
+any later version.
+
+GNU Classpath is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with GNU Classpath; see the file COPYING. If not, write to the
+Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+02110-1301 USA.
+
+Linking this library statically or dynamically with other modules is
+making a combined work based on this library. Thus, the terms and
+conditions of the GNU General Public License cover the whole
+combination.
+
+As a special exception, the copyright holders of this library give you
+permission to link this library with independent modules to produce an
+executable, regardless of the license terms of these independent
+modules, and to copy and distribute the resulting executable under
+terms of your choice, provided that you also meet, for each linked
+independent module, the terms and conditions of the license of that
+module. An independent module is a module which is not derived from
+or based on this library. If you modify this library, you may extend
+this exception to your version of the library, but you are not
+obligated to do so. If you do not wish to do so, delete this
+exception statement from your version. */
+
+package javax.annotation.processing;
+
+import java.util.Locale;
+
+import javax.lang.model.util.Elements;
+
+/**
+ * Provides the annotation processor with access to the
+ * facilities of the framework, such as the
+ * {@link Filer} for creating files and the
+ * {@link Messager} for printing messages to the user.
+ * It is possible to wrap implementations of this interface
+ * in order to provide additional functionality. However,
+ * doing so requires also implementing the dependent
+ * facility objects, such as the {@code Filer}, so that
+ * these additional changes are reflected throughout.
+ *
+ * @since 1.6
+ */
+public interface ProcessingEnvironment
+{
+
+ /**
+ * Returns an implementation of a number of utility
+ * methods which provide additional functionality for
+ * working with (@link javax.lang.model.element.Element}
+ * instances.
+ *
+ * @return the element utilities.
+ */
+ Elements getElementUtils();
+
+ /**
+ * Returns an implementation of the {@link Filer}
+ * which can be used to create source, class or
+ * resource files.
+ *
+ * @return the filer.
+ */
+ Filer getFiler();
+
+ /**
+ * Returns the locale used to localise messages from
+ * the {@link Messager} or {@code null} if one has not
+ * been set.
+ *
+ * @return the current locale or {@code null} if no
+ * locale has been setup.
+ */
+ Locale getLocale();
+
+ /**
+ * Returns an implementation of the {@link Messager}
+ * which is used to report back to the user, whether
+ * that be with errors, warnings or other issues.
+ *
+ * @return the messager.
+ */
+ Messager getMessager();
+
+
+
+}
diff --git a/javax/annotation/processing/RoundEnvironment.java b/javax/annotation/processing/RoundEnvironment.java
new file mode 100644
index 000000000..008b9e0ab
--- /dev/null
+++ b/javax/annotation/processing/RoundEnvironment.java
@@ -0,0 +1,119 @@
+/* RoundEnvironment.java -- Represents a round of annotation processing.
+ Copyright (C) 2012 Free Software Foundation, Inc.
+
+This file is part of GNU Classpath.
+
+GNU Classpath is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2, or (at your option)
+any later version.
+
+GNU Classpath is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with GNU Classpath; see the file COPYING. If not, write to the
+Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+02110-1301 USA.
+
+Linking this library statically or dynamically with other modules is
+making a combined work based on this library. Thus, the terms and
+conditions of the GNU General Public License cover the whole
+combination.
+
+As a special exception, the copyright holders of this library give you
+permission to link this library with independent modules to produce an
+executable, regardless of the license terms of these independent
+modules, and to copy and distribute the resulting executable under
+terms of your choice, provided that you also meet, for each linked
+independent module, the terms and conditions of the license of that
+module. An independent module is a module which is not derived from
+or based on this library. If you modify this library, you may extend
+this exception to your version of the library, but you are not
+obligated to do so. If you do not wish to do so, delete this
+exception statement from your version. */
+
+package javax.annotation.processing;
+
+import java.lang.annotation.Annotation;
+
+import java.util.Set;
+
+import javax.lang.model.element.Element;
+import javax.lang.model.element.TypeElement;
+
+/**
+ * Provides information used in a round of annotation processing.
+ * Annotation processing frameworks should provide an implementation
+ * of this interface, so that processors can be supplied with an instance
+ * in order to query information about their environment.
+ *
+ * @since 1.6
+ */
+public interface RoundEnvironment
+{
+
+ /**
+ * Returns true if the previous round of annotation processing
+ * raised an error.
+ *
+ * @return true if the previous round raised an error.
+ */
+ boolean errorRaised();
+
+ /**
+ * Returns the elements annotated with the given annotation type.
+ * Only the package and type elements, and their constituent
+ * member, parameter and type parameter elements, included in this
+ * round of annotation processing are returned. Both root type
+ * elements and any member type elements nested within them are
+ * included. The annotation may be used directly or inherited
+ * by another annotation. Elements in a package are not included
+ * simply because a package-info file was generated.
+ *
+ * @param annotation the annotation type requested.
+ * @return the elements annotated with the given annotation type
+ * or an empty set if none were found.
+ * @throws IllegalArgumentException if @code{annotation} does not
+ * represent an annotation type.
+ */
+ Set<? extends Element> getElementsAnnotatedWith(Class <? extends Annotation> annotation);
+
+ /**
+ * Returns the elements annotated with the given annotation type.
+ * Only the package and type elements, and their constituent
+ * member, parameter and type parameter elements, included in this
+ * round of annotation processing are returned. Both root type
+ * elements and any member type elements nested within them are
+ * included. The annotation may be used directly or inherited
+ * by another annotation. Elements in a package are not included
+ * simply because a package-info file was generated.
+ *
+ * @param annotation the annotation type requested.
+ * @return the elements annotated with the given annotation type
+ * or an empty set if none were found.
+ * @throws IllegalArgumentException if @code{annotation} does not
+ * represent an annotation type.
+ */
+ Set<? extends Element> getElementsAnnotatedWith(TypeElement annotation);
+
+ /**
+ * Returns the root elements generated by the previous round of
+ * annotation processing.
+ *
+ * @return the elements generated by the previous round or an
+ * empty set if none were generated.
+ */
+ Set<? extends Element> getRootElements();
+
+ /**
+ * Returns true if there will not be another round of processing
+ * on the elements generated by this round.
+ *
+ * @return true if the generated types will not be further processed.
+ */
+ boolean processingOver();
+
+}