APIdia Launch Partner
Top Description Inners Methods
javax.tools

public Interface JavaFileManager

extends Closeable, Flushable, OptionChecker
Known Direct Subinterfaces
javax.tools.StandardJavaFileManager
Known Direct Implementers
javax.tools.ForwardingJavaFileManager
Imports
java.io.Closeable, .Flushable, .IOException, java.net.URI, java.util.Iterator, .ServiceLoader, .Set, javax.annotation.processing.Filer, javax.lang.model.util.Elements
File manager for tools operating on Java programming language source and class files. In this context, file means an abstraction of regular files and other sources of data.

When constructing new JavaFileObjects, the file manager must determine where to create them. For example, if a file manager manages regular files on a file system, it would most likely have a current/working directory to use as default location when creating or finding files. A number of hints can be provided to a file manager as to where to create files. Any file manager might choose to ignore these hints.

Some methods in this interface use class names. Such class names must be given in the Java Virtual Machine internal form of fully qualified class and interface names. For convenience, '.' and '/' are interchangeable. The internal form is defined in chapter four of The Java Virtual Machine Specification.

Discussion: this means that the names "java/lang.package-info", "java/lang/package-info", "java.lang.package-info", are valid and equivalent. Compare to binary name as defined in The Java Language Specification, section 13.1 "The Form of a Binary".

The case of names is significant. All names should be treated as case-sensitive. For example, some file systems have case-insensitive, case-aware file names. File objects representing such files should take care to preserve case by using java.io.File#getCanonicalFile or similar means. If the system is not case-aware, file objects must use other means to preserve case.

Relative names: some methods in this interface use relative names. A relative name is a non-null, non-empty sequence of path segments separated by '/'. '.' or '..' are invalid path segments. A valid relative name must match the "path-rootless" rule of RFC 3986, section 3.3. Informally, this should be true:

URI.create(relativeName).normalize().getPath().equals(relativeName) 
URI.create(relativeName).normalize().getPath().equals(relativeName)

An object of this interface is not required to support multi-threaded access, that is, be synchronized. However, it must support concurrent access to different file objects created by this object.

Implementation Note

a consequence of this requirement is that a trivial implementation of output to a java.util.jar.JarOutputStream is not a sufficient implementation. That is, rather than creating a JavaFileObject that returns the JarOutputStream directly, the contents must be cached until closed and then written to the JarOutputStream.

Unless explicitly allowed, all methods in this interface might throw a NullPointerException if given a null argument.

Since
1.6
External Specification
https://www.rfc-editor.org/info/rfc3986
See Also
JavaFileObject, FileObject

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static interface
JavaFileManager.Location

Interface for locations of file objects.

Method Summary

Modifier and TypeMethod and Description
public void
close()

Redeclares java.io.Closeable.close.

Releases any resources opened by this file manager directly or indirectly.

public default boolean

Returns:

whether or not the file is contained in the location
contains(JavaFileManager.Location
the location
location, FileObject
the file object
fo)

Determines whether or not a given file object is "contained in" a specified location.

public void
flush()

Redeclares java.io.Flushable.flush.

Flushes any resources opened for output by this file manager directly or indirectly.

public ClassLoader

Returns:

a class loader for the given location; or null if loading plug-ins from the given location is disabled or if the location is not known
getClassLoader(JavaFileManager.Location
a location
location)

Returns a class loader for loading plug-ins from the given package-oriented location.

public FileObject

Returns:

a file object, might return null if the file does not exist
getFileForInput(JavaFileManager.Location
a package-oriented location
location, String
a package name
packageName, String
a relative name
relativeName)

Returns a file object for input representing the specified relative name in the specified package in the given package-oriented location.

public FileObject

Returns:

a file object
getFileForOutput(JavaFileManager.Location
an output location
location, String
a package name
packageName, String
a relative name
relativeName, FileObject
a file object to be used as hint for placement; might be null
sibling)

Returns a file object for output representing the specified relative name in the specified package in the given location.

public default FileObject

Returns:

a file object
getFileForOutputForOriginatingFiles(JavaFileManager.Location
an output location
location, String
a package name
packageName, String
a relative name
relativeName, FileObject...
the files which are contributing to this newly created file; null is equivalent to empty originatingFiles, meaning no known originating files
originatingFiles)

Returns a file object for output representing the specified relative name in the specified package in the given location.

public JavaFileObject

Returns:

a file object, might return null if the file does not exist
getJavaFileForInput(JavaFileManager.Location
a location
location, String
the name of a class
className, JavaFileObject.Kind
the kind of file, must be one of SOURCE or CLASS
kind)

Returns a file object for input representing the specified class of the specified kind in the given package-oriented location.

public JavaFileObject

Returns:

a file object for output
getJavaFileForOutput(JavaFileManager.Location
a package-oriented location
location, String
the name of a class
className, JavaFileObject.Kind
the kind of file, must be one of SOURCE or CLASS
kind, FileObject
a file object to be used as hint for placement; might be null
sibling)

Returns a file object for output representing the specified class of the specified kind in the given package-oriented location.

public default JavaFileObject

Returns:

a file object for output
getJavaFileForOutputForOriginatingFiles(JavaFileManager.Location
a package-oriented location
location, String
the name of a class
className, JavaFileObject.Kind
the kind of file, must be one of SOURCE or CLASS
kind, FileObject...
the files which are contributing to this newly created file; null is equivalent to empty originatingFiles, meaning no known originating files
originatingFiles)

Returns a file object for output representing the specified class of the specified kind in the given package-oriented location.

public default JavaFileManager.Location

Returns:

the location for the named module
getLocationForModule(JavaFileManager.Location
the module-oriented location
location, String
the name of the module to be found
moduleName)

Gets a location for a named module within a location, which may be either a module-oriented location or an output location.

public default JavaFileManager.Location

Returns:

the module containing the file
getLocationForModule(JavaFileManager.Location
the module-oriented location
location, JavaFileObject
the file
fo)

Gets a location for the module containing a specific file to be found within a location, which may be either a module-oriented location or an output location.

public default <
the service class
S> ServiceLoader<S>

Returns:

a service loader for the given service class
getServiceLoader(JavaFileManager.Location
the module-oriented location
location, Class<S>
the Class object of the service class
service)

Get a service loader for a specific service class from a given location.

public boolean

Returns:

true if this option was handled by this file manager, false otherwise
handleOption(String
current option
current, Iterator<String>
remaining options
remaining)

Handles one option.

public boolean

Returns:

true if the location is known
hasLocation(JavaFileManager.Location
a location
location)

Determines if a location is known to this file manager.

public String

Returns:

a binary name or null the file object is not found in the given location
inferBinaryName(JavaFileManager.Location
a location
location, JavaFileObject
a file object
file)

Infers a binary name of a file object based on a package-oriented location.

public default String

Returns:

the name of the module
inferModuleName(JavaFileManager.Location
a package-oriented location representing a module
location)

Infer the name of the module from its location, as returned by getLocationForModule or listModuleLocations.

public boolean

Returns:

true if the given file objects represent the same underlying object
isSameFile(FileObject
a file object
a, FileObject
a file object
b)

Compares two file objects and returns true if they represent the same underlying object.

public Iterable<JavaFileObject>

Returns:

an Iterable of file objects matching the given criteria
list(JavaFileManager.Location
a location
location, String
a package name
packageName, Set<JavaFileObject.Kind>
return objects only of these kinds
kinds, boolean
if true include "subpackages"
recurse)

Lists all file objects matching the given criteria in the given package-oriented location.

public default Iterable<Set<JavaFileManager.Location>>

Returns:

a series of sets of locations containing modules
listLocationsForModules(JavaFileManager.Location
the module-oriented location for which to list the modules
location)

Lists the locations for all the modules in a module-oriented location or an output location.

private static FileObject
siblingFrom(FileObject[] originatingFiles)

Inherited from javax.tools.OptionChecker:
isSupportedOption

Method Detail

closeback to summary
public void close() throws IOException

Redeclares java.io.Closeable.close.

Releases any resources opened by this file manager directly or indirectly. This might render this file manager useless and the effect of subsequent calls to methods on this object or any objects obtained through this object is undefined unless explicitly allowed. However, closing a file manager which has already been closed has no effect.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurred
See Also
flush
containsback to summary
public default boolean contains(JavaFileManager.Location location, FileObject fo) throws IOException

Determines whether or not a given file object is "contained in" a specified location.

For a package-oriented location, a file object is contained in the location if there exist values for packageName and relativeName such that either of the following calls would return the same file object:

getFileForInput(location, packageName, relativeName) getFileForOutput(location, packageName, relativeName, null) 
getFileForInput(location, packageName, relativeName)
getFileForOutput(location, packageName, relativeName, null)

For a module-oriented location, a file object is contained in the location if there exists a module that may be obtained by the call:

getLocationForModule(location, moduleName) 
getLocationForModule(location, moduleName)
such that the file object is contained in the (package-oriented) location for that module.

Implementation Specification

This implementation throws UnsupportedOperationException.

Parameters
location:JavaFileManager.Location

the location

fo:FileObject

the file object

Returns:boolean

whether or not the file is contained in the location

Exceptions
IOException:
if there is a problem determining the result
UnsupportedOperationException:
if the method is not supported
Since
9
flushback to summary
public void flush() throws IOException

Redeclares java.io.Flushable.flush.

Flushes any resources opened for output by this file manager directly or indirectly. Flushing a closed file manager has no effect.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurred
See Also
close
getClassLoaderback to summary
public ClassLoader getClassLoader(JavaFileManager.Location location)

Returns a class loader for loading plug-ins from the given package-oriented location. For example, to load annotation processors, a compiler will request a class loader for the ANNOTATION_PROCESSOR_PATH location.

Parameters
location:JavaFileManager.Location

a location

Returns:ClassLoader

a class loader for the given location; or null if loading plug-ins from the given location is disabled or if the location is not known

Exceptions
IllegalStateException:
if close has been called and this file manager cannot be reopened
IllegalArgumentException:
if the location is a module-oriented location
getFileForInputback to summary
public FileObject getFileForInput(JavaFileManager.Location location, String packageName, String relativeName) throws IOException

Returns a file object for input representing the specified relative name in the specified package in the given package-oriented location.

If the returned object represents a source or class file, it must be an instance of JavaFileObject.

Informally, the file object returned by this method is located in the concatenation of the location, package name, and relative name. For example, to locate the properties file "resources/compiler.properties" in the package "com.sun.tools.javac" in the SOURCE_PATH location, this method might be called like so:

getFileForInput(SOURCE_PATH, "com.sun.tools.javac", "resources/compiler.properties"); 
getFileForInput(SOURCE_PATH, "com.sun.tools.javac", "resources/compiler.properties");

If the call was executed on Windows, with SOURCE_PATH set to "C:\Documents and Settings\UncleBob\src\share\classes", a valid result would be a file object representing the file "C:\Documents and Settings\UncleBob\src\share\classes\com\sun\tools\javac\resources\compiler.properties".

Parameters
location:JavaFileManager.Location

a package-oriented location

packageName:String

a package name

relativeName:String

a relative name

Returns:FileObject

a file object, might return null if the file does not exist

Exceptions
IOException:
if an I/O error occurred, or if close has been called and this file manager cannot be reopened
IllegalArgumentException:
if the location is not known to this file manager and the file manager does not support unknown locations, or if relativeName is not valid, or if the location is a module-oriented location
IllegalStateException:
if close has been called and this file manager cannot be reopened
getFileForOutputback to summary
public FileObject getFileForOutput(JavaFileManager.Location location, String packageName, String relativeName, FileObject sibling) throws IOException

Returns a file object for output representing the specified relative name in the specified package in the given location.

Optionally, this file manager might consider the sibling as a hint for where to place the output. The exact semantics of this hint is unspecified. The JDK compiler, javac, for example, will place class files in the same directories as originating source files unless a class file output directory is provided. To facilitate this behavior, javac might provide the originating source file as sibling when calling this method.

If the returned object represents a source or class file, it must be an instance of JavaFileObject.

Informally, the file object returned by this method is located in the concatenation of the location, package name, and relative name or next to the sibling argument. See getFileForInput for an example.

Parameters
location:JavaFileManager.Location

an output location

packageName:String

a package name

relativeName:String

a relative name

sibling:FileObject

a file object to be used as hint for placement; might be null

Returns:FileObject

a file object

Exceptions
IOException:
if an I/O error occurred, or if close has been called and this file manager cannot be reopened
IllegalArgumentException:
if sibling is not known to this file manager, or if the location is not known to this file manager and the file manager does not support unknown locations, or if relativeName is not valid, or if the location is not an output location
IllegalStateException:
if close has been called and this file manager cannot be reopened
getFileForOutputForOriginatingFilesback to summary
public default FileObject getFileForOutputForOriginatingFiles(JavaFileManager.Location location, String packageName, String relativeName, FileObject... originatingFiles) throws IOException

Returns a file object for output representing the specified relative name in the specified package in the given location.

The provided originatingFiles represent files that were, in an unspecified way, used to create the content of the file created by this method. See originatingElements in Filer#createResource. Elements#getFileObjectOf may be used to convert the Elements to FileObjects.

If the returned object represents a source or class file, it must be an instance of JavaFileObject.

Informally, the file object returned by this method is located in the concatenation of the location, package name, and relative name or in a location inferred from the originatingFiles. See getFileForInput for an example.

Implementation Specification

The default implementation calls getFileForOutput(javax.tools.JavaFileManager.Location, java.lang.String, java.lang.String, javax.tools.FileObject) with the first element of the originatingFiles, if any, as a sibling.

Parameters
location:JavaFileManager.Location

an output location

packageName:String

a package name

relativeName:String

a relative name

originatingFiles:FileObject[]

the files which are contributing to this newly created file; null is equivalent to empty originatingFiles, meaning no known originating files

Returns:FileObject

a file object

Exceptions
IOException:
if an I/O error occurred, or if close has been called and this file manager cannot be reopened
IllegalArgumentException:
if sibling is not known to this file manager, or if the location is not known to this file manager and the file manager does not support unknown locations, or if relativeName is not valid, or if the location is not an output location
IllegalStateException:
if close has been called and this file manager cannot be reopened
Since
18
See Also
Filer#createResource
getJavaFileForInputback to summary
public JavaFileObject getJavaFileForInput(JavaFileManager.Location location, String className, JavaFileObject.Kind kind) throws IOException

Returns a file object for input representing the specified class of the specified kind in the given package-oriented location.

Parameters
location:JavaFileManager.Location

a location

className:String

the name of a class

kind:JavaFileObject.Kind

the kind of file, must be one of SOURCE or CLASS

Returns:JavaFileObject

a file object, might return null if the file does not exist

Exceptions
IOException:
if an I/O error occurred, or if close has been called and this file manager cannot be reopened
IllegalArgumentException:
if the location is not known to this file manager and the file manager does not support unknown locations, or if the kind is not valid, or if the location is a module-oriented location
IllegalStateException:
if close has been called and this file manager cannot be reopened
getJavaFileForOutputback to summary
public JavaFileObject getJavaFileForOutput(JavaFileManager.Location location, String className, JavaFileObject.Kind kind, FileObject sibling) throws IOException

Returns a file object for output representing the specified class of the specified kind in the given package-oriented location.

Optionally, this file manager might consider the sibling as a hint for where to place the output. The exact semantics of this hint is unspecified. The JDK compiler, javac, for example, will place class files in the same directories as originating source files unless a class file output directory is provided. To facilitate this behavior, javac might provide the originating source file as sibling when calling this method.

Parameters
location:JavaFileManager.Location

a package-oriented location

className:String

the name of a class

kind:JavaFileObject.Kind

the kind of file, must be one of SOURCE or CLASS

sibling:FileObject

a file object to be used as hint for placement; might be null

Returns:JavaFileObject

a file object for output

Exceptions
IOException:
if an I/O error occurred, or if close has been called and this file manager cannot be reopened
IllegalArgumentException:
if sibling is not known to this file manager, or if the location is not known to this file manager and the file manager does not support unknown locations, or if the kind is not valid, or if the location is not an output location
IllegalStateException:
close has been called and this file manager cannot be reopened
getJavaFileForOutputForOriginatingFilesback to summary
public default JavaFileObject getJavaFileForOutputForOriginatingFiles(JavaFileManager.Location location, String className, JavaFileObject.Kind kind, FileObject... originatingFiles) throws IOException

Returns a file object for output representing the specified class of the specified kind in the given package-oriented location.

The provided originatingFiles represent files that were, in an unspecified way, used to create the content of the file created by this method. See originatingElements in Filer#createSourceFile. Elements#getFileObjectOf may be used to convert the Elements to FileObjects.

Implementation Specification

The default implementation calls getJavaFileForOutput(javax.tools.JavaFileManager.Location, java.lang.String, javax.tools.JavaFileObject.Kind, javax.tools.FileObject) with the first element of the originatingFiles, if any, as a sibling.

Parameters
location:JavaFileManager.Location

a package-oriented location

className:String

the name of a class

kind:JavaFileObject.Kind

the kind of file, must be one of SOURCE or CLASS

originatingFiles:FileObject[]

the files which are contributing to this newly created file; null is equivalent to empty originatingFiles, meaning no known originating files

Returns:JavaFileObject

a file object for output

Exceptions
IOException:
if an I/O error occurred, or if close has been called and this file manager cannot be reopened
IllegalArgumentException:
if sibling is not known to this file manager, or if the location is not known to this file manager and the file manager does not support unknown locations, or if the kind is not valid, or if the location is not an output location
IllegalStateException:
close has been called and this file manager cannot be reopened
Since
18
See Also
Filer#createSourceFile
getLocationForModuleback to summary
public default JavaFileManager.Location getLocationForModule(JavaFileManager.Location location, String moduleName) throws IOException

Gets a location for a named module within a location, which may be either a module-oriented location or an output location. The result will be an output location if the given location is an output location, or it will be a package-oriented location.

Implementation Specification

This implementation throws UnsupportedOperationException.

Parameters
location:JavaFileManager.Location

the module-oriented location

moduleName:String

the name of the module to be found

Returns:JavaFileManager.Location

the location for the named module

Exceptions
IOException:
if an I/O error occurred
UnsupportedOperationException:
if this operation is not supported by this file manager
IllegalArgumentException:
if the location is neither an output location nor a module-oriented location
Since
9
getLocationForModuleback to summary
public default JavaFileManager.Location getLocationForModule(JavaFileManager.Location location, JavaFileObject fo) throws IOException

Gets a location for the module containing a specific file to be found within a location, which may be either a module-oriented location or an output location. The result will be an output location if the given location is an output location, or it will be a package-oriented location.

Implementation Specification

This implementation throws UnsupportedOperationException.

Parameters
location:JavaFileManager.Location

the module-oriented location

fo:JavaFileObject

the file

Returns:JavaFileManager.Location

the module containing the file

Exceptions
IOException:
if an I/O error occurred
UnsupportedOperationException:
if this operation is not supported by this file manager
IllegalArgumentException:
if the location is neither an output location nor a module-oriented location
Since
9
getServiceLoaderback to summary
public default <S> ServiceLoader<S> getServiceLoader(JavaFileManager.Location location, Class<S> service) throws IOException

Get a service loader for a specific service class from a given location. If the location is a module-oriented location, the service loader will use the service declarations in the modules found in that location. Otherwise, a service loader is created using the package-oriented location, in which case, the services are determined using the provider-configuration files in META-INF/services.

Implementation Specification

This implementation throws UnsupportedOperationException.

Parameters
<S>
the service class
location:JavaFileManager.Location

the module-oriented location

service:Class<S>

the Class object of the service class

Returns:ServiceLoader<S>

a service loader for the given service class

Exceptions
IOException:
if an I/O error occurred
UnsupportedOperationException:
if this operation is not supported by this file manager
Since
9
handleOptionback to summary
public boolean handleOption(String current, Iterator<String> remaining)

Handles one option. If current is an option to this file manager, it will consume any arguments to that option from remaining and return true, otherwise return false.

Parameters
current:String

current option

remaining:Iterator<String>

remaining options

Returns:boolean

true if this option was handled by this file manager, false otherwise

Exceptions
IllegalArgumentException:
if this option to this file manager is used incorrectly
IllegalStateException:
if close has been called and this file manager cannot be reopened
hasLocationback to summary
public boolean hasLocation(JavaFileManager.Location location)

Determines if a location is known to this file manager.

Parameters
location:JavaFileManager.Location

a location

Returns:boolean

true if the location is known

inferBinaryNameback to summary
public String inferBinaryName(JavaFileManager.Location location, JavaFileObject file)

Infers a binary name of a file object based on a package-oriented location. The binary name returned might not be a valid binary name according to The Java Language Specification.

Parameters
location:JavaFileManager.Location

a location

file:JavaFileObject

a file object

Returns:String

a binary name or null the file object is not found in the given location

Exceptions
IllegalArgumentException:
if the location is a module-oriented location
IllegalStateException:
if close has been called and this file manager cannot be reopened
inferModuleNameback to summary
public default String inferModuleName(JavaFileManager.Location location) throws IOException

Infer the name of the module from its location, as returned by getLocationForModule or listModuleLocations.

Implementation Specification

This implementation throws UnsupportedOperationException.

Parameters
location:JavaFileManager.Location

a package-oriented location representing a module

Returns:String

the name of the module

Exceptions
IOException:
if an I/O error occurred
UnsupportedOperationException:
if this operation is not supported by this file manager
IllegalArgumentException:
if the location is not one known to this file manager
Since
9
isSameFileback to summary
public boolean isSameFile(FileObject a, FileObject b)

Compares two file objects and returns true if they represent the same underlying object.

Parameters
a:FileObject

a file object

b:FileObject

a file object

Returns:boolean

true if the given file objects represent the same underlying object

Exceptions
IllegalArgumentException:
if either of the arguments were created with another file manager and this file manager does not support foreign file objects
listback to summary
public Iterable<JavaFileObject> list(JavaFileManager.Location location, String packageName, Set<JavaFileObject.Kind> kinds, boolean recurse) throws IOException

Lists all file objects matching the given criteria in the given package-oriented location. List file objects in "subpackages" if recurse is true.

Note

even if the given location is unknown to this file manager, it may not return null. Also, an unknown location may not cause an exception.

Parameters
location:JavaFileManager.Location

a location

packageName:String

a package name

kinds:Set<JavaFileObject.Kind>

return objects only of these kinds

recurse:boolean

if true include "subpackages"

Returns:Iterable<JavaFileObject>

an Iterable of file objects matching the given criteria

Exceptions
IOException:
if an I/O error occurred, or if close has been called and this file manager cannot be reopened
IllegalArgumentException:
if the location is a module-oriented location
IllegalStateException:
if close has been called and this file manager cannot be reopened
listLocationsForModulesback to summary
public default Iterable<Set<JavaFileManager.Location>> listLocationsForModules(JavaFileManager.Location location) throws IOException

Lists the locations for all the modules in a module-oriented location or an output location. The locations that are returned will be output locations if the given location is an output, or it will be a package-oriented locations.

Implementation Specification

This implementation throws UnsupportedOperationException.

Parameters
location:JavaFileManager.Location

the module-oriented location for which to list the modules

Returns:Iterable<Set<JavaFileManager.Location>>

a series of sets of locations containing modules

Exceptions
IOException:
if an I/O error occurred
UnsupportedOperationException:
if this operation is not supported by this file manager
IllegalArgumentException:
if the location is not a module-oriented location
Since
9
siblingFromback to summary
private static FileObject siblingFrom(FileObject[] originatingFiles)
javax.tools back to summary

public Interface JavaFileManager.Location

Known Direct Implementers
javax.tools.StandardLocation, javax.tools.DocumentationTool.Location
Interface for locations of file objects. Used by file managers to determine where to place or search for file objects.

Informally, a Location corresponds to a "search path", such as a class path or module path, as used by command-line tools that use the default file system.

Some locations are typically used to identify a place in which a tool can find files to be read; others are typically used to identify a place where a tool can write files. If a location is used to identify a place for reading files, those files may be organized in a simple package/class hierarchy: such locations are described as package-oriented. Alternatively, the files may be organized in a module/package/class hierarchy: such locations are described as module-oriented. If a location is typically used to identify a place where a tool can write files, it is up to the tool that writes the files to specify how those files will be organized.

You can access the classes in a package-oriented location using methods like JavaFileManager#getJavaFileForInput or JavaFileManager#list. It is not possible to directly list the classes in a module-oriented location. Instead, you can get a package-oriented location for any specific module using methods like JavaFileManager#getLocationForModule or JavaFileManager#listLocationsForModules.

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

a name
getName()

Returns the name of this location.

public default boolean

Returns:

true if this location is expected to contain modules
isModuleOrientedLocation()

Indicates if this location is module-oriented location, and therefore expected to contain classes in a module/package/class hierarchy, as compared to a package-oriented location, which is expected to contain classes in a package/class hierarchy.

public boolean

Returns:

true if this is an output location, false otherwise
isOutputLocation()

Determines if this is an output location.

Method Detail

getNameback to summary
public String getName()

Returns the name of this location.

Returns:String

a name

isModuleOrientedLocationback to summary
public default boolean isModuleOrientedLocation()

Indicates if this location is module-oriented location, and therefore expected to contain classes in a module/package/class hierarchy, as compared to a package-oriented location, which is expected to contain classes in a package/class hierarchy. The result of this method is undefined if this is an output location.

Implementation Specification

This implementation returns true if the name includes the word "MODULE".

Returns:boolean

true if this location is expected to contain modules

Since
9
isOutputLocationback to summary
public boolean isOutputLocation()

Determines if this is an output location. An output location is a location that is conventionally used for output.

API Note

An output location may be used to write files in either a package-oriented organization or in a module-oriented organization.

Returns:boolean

true if this is an output location, false otherwise