Module com.github.sormuras.bach

Package com.github.sormuras.bach.simple

Record Class SimpleSpace

java.lang.Object

java.lang.Record

com.github.sormuras.bach.simple.SimpleSpace

All Implemented Interfaces:

SimpleBuilder

public record SimpleSpace(Bach bach, Optional<String> name, Optional<Integer> release, List<SimpleModule> modules, ModuleSourcePathPatternsOption moduleSourcePaths, ModulePathsOption modulePaths)
extends Record
implements SimpleBuilder

A simplified module source space configuration and builder class.

Constructor Summary

Constructors

Constructor	Description
SimpleSpace(Bach bach)
SimpleSpace(Bach bach, Optional<String> name, Optional<Integer> release, List<SimpleModule> modules, ModuleSourcePathPatternsOption moduleSourcePaths, ModulePathsOption modulePaths)	Creates an instance of a SimpleSpace record class.

Method Summary

Modifier and Type	Method	Description
Bach	bach()	Returns the value of the bach record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
ModulePathsOption	modulePaths()	Returns the value of the modulePaths record component.
List<SimpleModule>	modules()	Returns the value of the modules record component.
ModuleSourcePathPatternsOption	moduleSourcePaths()	Returns the value of the moduleSourcePaths record component.
Optional<String>	name()	Returns the value of the name record component.
static SimpleSpace	of(Bach bach)
static SimpleSpace	of(Bach bach, String name)
Optional<Integer>	release()	Returns the value of the release record component.
SimpleSpace	space()
List<String>	toModuleNames()
final String	toString()	Returns a string representation of this record class.
SimpleSpace	withModule(String name)
SimpleSpace	withModule(String name, UnaryOperator<SimpleModule> operator)
SimpleSpace	withModulePaths(Path... paths)
SimpleSpace	withModules(List<SimpleModule> modules)
SimpleSpace	withModuleSourcePaths(String... patterns)
SimpleSpace	withName(String name)
SimpleSpace	withRelease(Integer release)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.sormuras.bach.simple.SimpleBuilder

compile, compile, compile, document, grab, link, newDependentSpace, outputDirectoryForClasses, outputDirectoryForModules, outputDirectoryForReports, runAllTests, runJUnit, runJUnit, runJUnit, runModule, runModule, runTool, runTool

Constructor Details

SimpleSpace

public SimpleSpace(Bach bach)

SimpleSpace

public SimpleSpace(Bach bach,
 Optional<String> name,
 Optional<Integer> release,
 List<SimpleModule> modules,
 ModuleSourcePathPatternsOption moduleSourcePaths,
 ModulePathsOption modulePaths)

Creates an instance of a SimpleSpace record class.

Parameters:

bach - the value for the bach record component

name - the value for the name record component

release - the value for the release record component

modules - the value for the modules record component

moduleSourcePaths - the value for the moduleSourcePaths record component

modulePaths - the value for the modulePaths record component

Method Details

of

public static SimpleSpace of(Bach bach)

of

public static SimpleSpace of(Bach bach,
 String name)

bach

public Bach bach()

Returns the value of the bach record component.

Specified by:

bach in interface SimpleBuilder

Returns:

the value of the bach record component

space

public SimpleSpace space()

Specified by:

space in interface SimpleBuilder

withName

public SimpleSpace withName(String name)

withRelease

public SimpleSpace withRelease(Integer release)

withModules

public SimpleSpace withModules(List<SimpleModule> modules)

withModule

public SimpleSpace withModule(String name)

withModule

public SimpleSpace withModule(String name,
 UnaryOperator<SimpleModule> operator)

withModuleSourcePaths

public SimpleSpace withModuleSourcePaths(String... patterns)

withModulePaths

public SimpleSpace withModulePaths(Path... paths)

toModuleNames

public List<String> toModuleNames()

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.

name

public Optional<String> name()

Returns the value of the name record component.

Returns:

the value of the name record component

release

public Optional<Integer> release()

Returns the value of the release record component.

Returns:

the value of the release record component

modules

public List<SimpleModule> modules()

Returns the value of the modules record component.

Returns:

the value of the modules record component

moduleSourcePaths

public ModuleSourcePathPatternsOption moduleSourcePaths()

Returns the value of the moduleSourcePaths record component.

Returns:

the value of the moduleSourcePaths record component

modulePaths

public ModulePathsOption modulePaths()

Returns the value of the modulePaths record component.

Returns:

the value of the modulePaths record component