/*
* Copyright (c) 2005, 2014, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code 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
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package javax.tools;
import javax.lang.model.element.NestingKind;
import javax.lang.model.element.Modifier;
import java.util.Objects;
File abstraction for tools operating on Java programming language
source and class files.
All methods in this interface might throw a SecurityException if
a security exception occurs.
Unless explicitly allowed, all methods in this interface might throw a NullPointerException if given a null
argument.
Author: Peter von der Ahé, Jonathan Gibbons See Also: Since: 1.6
/**
* 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.
/**
* Kinds of JavaFileObjects.
*/
enum Kind {
Source files written in the Java programming language. For example, regular files ending with .java
. /**
* 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 .class
. /**
* 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
.html
. /**
* HTML files. For example, regular files ending with {@code
* .html}.
*/
HTML(".html"),
Any other kind.
/**
* 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 (""
) is used. /**
* 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) {
this.extension = Objects.requireNonNull(extension);
}
}
Returns the kind of this file object.
Returns: the kind
/**
* Returns 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 Java Language Specification,
section 6.2 "Names and Identifiers".
Params: - simpleName – a simple name of a class
- kind – a kind
Returns: true
if this file object is compatible; false otherwise
/**
* 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
* <cite>The Java Language Specification</cite>,
* 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 NestingKind.MEMBER
to mean NestingKind.LOCAL
or NestingKind.ANONYMOUS
. If the nesting level is not known or this file object does not represent a class file this method returns null
. Returns: the nesting kind, or null
if the nesting kind is not known
/**
* 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 null
. Returns: the access level
/**
* 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();
}