summaryrefslogtreecommitdiff
path: root/javax/tools/JavaFileObject.java
diff options
context:
space:
mode:
authorAndrew John Hughes <gnu_andrew@member.fsf.org>2012-11-20 04:04:17 +0000
committerAndrew John Hughes <gnu_andrew@member.fsf.org>2012-11-20 04:04:17 +0000
commit2779d6fe0f5dd175c54f7e415753b0224c593c03 (patch)
tree787591ededd6b2b9fc052fc9aeac272e505bbe4a /javax/tools/JavaFileObject.java
parentc54ec9a581cb50d3ee475b11a294c56ff6e15208 (diff)
downloadclasspath-2779d6fe0f5dd175c54f7e415753b0224c593c03.tar.gz
Add JavaFileManager and JavaFileObject, along with methods that use them in Filer and any dependent classes.
2012-11-19 Andrew John Hughes <gnu_andrew@member.fsf.org> * javax/annotation/processing/Filer.java: (createClassFile(CharSequence,Element...): Added. (createResource(JavaFileManager.Location, CharSequence, CharSequence, Element...)): Likewise. (createSourceFile(CharSequence,Element...): Likewise. (getResource(JavaFileManager.Location, CharSequence, CharSequence)): Likewise. * javax/annotation/processing/FilerException.java: New class. (FilerException(String)): Implemented. * javax/tools/JavaFileManager.java: New interface. (Location): New member interface. (Location.getName()): Added. (Location.isOutputLocation()): Likewise. (close()): Likewise. (flush()): Likewise. (getClassLoader(Location)): Likewise. (getFileForInput(Location,String,String)): Likewise. (getFileForOutput(Location,String,String,FileObject)): Likewise. (getJavaFileForInput(Location,String, JavaFileObject.Kind)): Likewise. (getJavaFileForOutput(Location,String, JavaFileObject.Kind,FileObject)): Likewise. (handleOption(String,Iterator)): Likewise. (hasLocation(Location)): Likewise. (inferBinaryName(Location,JavaFileObject)): Likewise. (isSameFile(FileObject,FileObject)): Likewise. (list(Location,String,Set,boolean)): Likewise. * javax/tools/JavaFileObject.java: New interface. (Kind): New inner enum. (CLASS): Added. (HTML): Likewise. (OTHER): Likewise. (SOURCE): Likewise. (Kind.extension): New public field. (Kind.Kind(String)): Implemented. (getKind()): Added. (isNameCompatible(String,Kind)): Likewise. * javax/tools/OptionChecker.java: New interface. (isSupportedOption(String)): Added. * javax/tools/StandardLocation.java: New enum. (ANNOTATION_PROCESSOR_PATH): Added. (CLASS_OUTPUT): Likewise. (CLASS_PATH): Likewise. (PLATFORM_CLASS_PATH): Likewise. (SOURCE_OUTPUT): Likewise. (SOURCE_PATH): Likewise. (locCache): Likewise. (getName()): Implemented. (locationFor(String)): Implemented. Signed-off-by: Andrew John Hughes <gnu_andrew@member.fsf.org>
Diffstat (limited to 'javax/tools/JavaFileObject.java')
-rw-r--r--javax/tools/JavaFileObject.java99
1 files changed, 99 insertions, 0 deletions
diff --git a/javax/tools/JavaFileObject.java b/javax/tools/JavaFileObject.java
new file mode 100644
index 000000000..09bd3417d
--- /dev/null
+++ b/javax/tools/JavaFileObject.java
@@ -0,0 +1,99 @@
+/* JavaFileObject.java -- Abstraction for working with class & source files.
+ 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.tools;
+
+/**
+ * Abstraction for tools working with source and class files.
+ * All methods may throw a {@link SecurityException}. All
+ * methods may throw a {@link NullPointerException} if supplied
+ * with a {@code null} argument, unless otherwise specified.
+ *
+ * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
+ * @since 1.6
+ */
+public interface JavaFileObject
+ extends FileObject
+{
+
+ /**
+ * Kinds of Java files.
+ *
+ * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
+ * @since 1.6
+ */
+ public enum Kind
+ {
+ /** Java class files, which end in {@code ".class"} */ CLASS (".class"),
+ /** Web pages, which end in {@code "*.html"} */ HTML (".html"),
+ /** Any other kind of file. */ OTHER (""),
+ /** Java source files, which end in {@code ".java"} */ SOURCE (".java");
+
+ /**
+ * The file extension usually used for files of this
+ * type. If there is no conventional extension for
+ * this type, this field is set to the empty string,
+ * {@code ""}.
+ */
+ public final String extension;
+
+ Kind(String extension)
+ {
+ this.extension = extension;
+ }
+
+ }
+
+ /**
+ * Returns the kind of this file object.
+ *
+ * @return the kind.
+ */
+ Kind getKind();
+
+ /**
+ * Checks if this file object represents the specified
+ * kind of file for the supplied type. The class name is
+ * a simple name i.e. not qualified.
+ *
+ * @param simpleName the simple name of the class.
+ * @param kind the kind of file.
+ * @return true if this object matches the type specified.
+ */
+ boolean isNameCompatible(String simpleName, Kind kind);
+
+}