Module com.github.sormuras.bach

Package com.github.sormuras.bach

Record Class Explorer

java.lang.Object

java.lang.Record

com.github.sormuras.bach.Explorer

public record Explorer(Bach bach)
extends Record

An Explorer finds files, lists modules, and helps explore other assets and states.

Constructor Summary

Constructors

Constructor	Description
Explorer(Bach bach)	Creates an instance of a Explorer record class.

Method Summary

Modifier and Type	Method	Description
Bach	bach()	Returns the value of the bach record component.
static TreeSet<String>	declared(ModuleFinder finder)
static TreeSet<String>	declared(Stream<ModuleDescriptor> descriptors)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
List<Path>	findJavaFiles()
List<Path>	findJavaFiles(Path root)
List<Path>	findModuleInfoJavaFiles()
List<Path>	findModuleInfoJavaFiles(Path root)
final int	hashCode()	Returns a hash code value for this object.
List<String>	listMissingExternalModules(ModuleFinder finder, String... more)
List<String>	listMissingExternalModules(String... more)
List<String>	listMissingExternalModules(List<ModuleFinder> finders, Set<String> more)
ModuleFinder	newModuleInfoFinder(Path root)
static boolean	required(ModuleDescriptor.Requires requires)
static TreeSet<String>	required(ModuleFinder finder)
static TreeSet<String>	required(Stream<ModuleDescriptor> descriptors)
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

Explorer

public Explorer(Bach bach)

Creates an instance of a Explorer record class.

Parameters:

bach - the value for the bach record component

Method Details

newModuleInfoFinder

public ModuleFinder newModuleInfoFinder(Path root)

findJavaFiles

public List<Path> findJavaFiles()

findJavaFiles

public List<Path> findJavaFiles(Path root)

findModuleInfoJavaFiles

public List<Path> findModuleInfoJavaFiles()

findModuleInfoJavaFiles

public List<Path> findModuleInfoJavaFiles(Path root)

listMissingExternalModules

public List<String> listMissingExternalModules(String... more)

listMissingExternalModules

public List<String> listMissingExternalModules(ModuleFinder finder,
 String... more)

listMissingExternalModules

public List<String> listMissingExternalModules(List<ModuleFinder> finders,
 Set<String> more)

declared

public static TreeSet<String> declared(ModuleFinder finder)

declared

public static TreeSet<String> declared(Stream<ModuleDescriptor> descriptors)

required

public static TreeSet<String> required(ModuleFinder finder)

required

public static TreeSet<String> required(Stream<ModuleDescriptor> descriptors)

required

public static boolean required(ModuleDescriptor.Requires requires)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

bach

public Bach bach()

Returns the value of the bach record component.

Returns:

the value of the bach record component