Module io.github.ascopes.jct

Package io.github.ascopes.jct.filemanagers

Class ModuleLocation

java.lang.Object

io.github.ascopes.jct.filemanagers.ModuleLocation

All Implemented Interfaces:

JavaFileManager.Location

@API(since="0.0.1",
     status=STABLE)
public final class ModuleLocation
extends Object
implements JavaFileManager.Location

Handle that represents the location of a module.

Since:

0.0.1

Author:

Ashley Scopes

Constructor Summary

Constructors

Constructor	Description
ModuleLocation(JavaFileManager.Location parent, String moduleName)	Initialize the location.

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object other)
String	getModuleName()	Get the module name.
String	getName()
JavaFileManager.Location	getParent()	Get the parent location.
int	hashCode()
boolean	isModuleOrientedLocation()
boolean	isOutputLocation()
String	toString()
static Optional<ModuleLocation>	upcast(JavaFileManager.Location location)	Attempt to upcast a given location to a ModuleLocation if it is an instance of ModuleLocation.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ModuleLocation

public ModuleLocation(JavaFileManager.Location parent,
 String moduleName)

Initialize the location.

Parameters:

parent - the parent location.

moduleName - the module name.

Throws:

JctIllegalInputException - if the parent location is not an output location or a module-oriented location.

Method Details

getParent

public JavaFileManager.Location getParent()

Get the parent location.

Returns:

the parent location.

getModuleName

public String getModuleName()

Get the module name.

Returns:

the module name.

getName

public String getName()

Specified by:

getName in interface JavaFileManager.Location

isOutputLocation

public boolean isOutputLocation()

Specified by:

isOutputLocation in interface JavaFileManager.Location

isModuleOrientedLocation

public boolean isModuleOrientedLocation()

Specified by:

isModuleOrientedLocation in interface JavaFileManager.Location

equals

public boolean equals(@Nullable Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

upcast

@API(since="1.1.5",
     status=STABLE)
public static Optional<ModuleLocation> upcast(JavaFileManager.Location location)

Attempt to upcast a given location to a ModuleLocation if it is an instance of ModuleLocation.

Parameters:

location - the location to attempt to upcast.

Returns:

an optional containing the upcast location if it is a module location, or an empty optional if not.