1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
/* * @(#)JavaFileObject.java 1.8 06/09/25 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package javax.tools; import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; import java.io.Reader; import java.io.Writer; import java.nio.CharBuffer; import javax.lang.model.element.NestingKind; import javax.lang.model.element.Modifier; /** * File abstraction for tools operating on Java™ programming language * source and class files. * * <p>All methods in this interface might throw a SecurityException if * a security exception occurs. * * <p>Unless explicitly allowed, all methods in this interface might * throw a NullPointerException if given a {@code null} argument. * * @author Peter von der Ahé * @author Jonathan Gibbons * @see JavaFileManager * @since 1.6 */ public interface JavaFileObject extends FileObject { /** * Kinds of JavaFileObjects. */ enum Kind { /** * Source files written in the Java programming language. For * example, regular files ending with {@code .java}. */ SOURCE(".java"), /** * Class files for the Java Virtual Machine. For example, * regular files ending with {@code .class}. */ CLASS(".class"), /** * HTML files. For example, regular files ending with {@code * .html}. */ HTML(".html"), /** * Any other kind. */ OTHER(""); /** * The extension which (by convention) is normally used for * this kind of file object. If no convention exists, the * empty string ({@code ""}) is used. */ public final String extension; private Kind(String extension) { extension.getClass(); // null check this.extension = extension; } }; /** * Gets the kind of this file object. * * @return the kind */ Kind getKind(); /** * Checks if this file object is compatible with the specified * simple name and kind. A simple name is a single identifier * (not qualified) as defined in the <a * href="http://java.sun.com/docs/books/jls/">Java Language * Specification</a> 3rd ed., section 6.2 "Names and Identifiers". * * @param simpleName a simple name of a class * @param kind a kind * @return {@code true} if this file object is compatible; false * otherwise */ boolean isNameCompatible(String simpleName, Kind kind); /** * Provides a hint about the nesting level of the class * represented by this file object. This method may return * {@link NestingKind#MEMBER} to mean * {@link NestingKind#LOCAL} or {@link NestingKind#ANONYMOUS}. * If the nesting level is not known or this file object does not * represent a class file this method returns {@code null}. * * @return the nesting kind, or {@code null} if the nesting kind * is not known */ NestingKind getNestingKind(); /** * Provides a hint about the access level of the class represented * by this file object. If the access level is not known or if * this file object does not represent a class file this method * returns {@code null}. * * @return the access level */ Modifier getAccessLevel(); }