Module com.github.sormuras.bach

Package com.github.sormuras.bach.simple

Record Class SimpleModule

java.lang.Object

java.lang.Record

com.github.sormuras.bach.simple.SimpleModule

public record SimpleModule(String name, Optional<String> main, List<Path> resources)
extends Record

Describes a source module in a conventional "simple" project space.

Constructor Summary

Constructors

Constructor	Description
SimpleModule(String name, Optional<String> main, List<Path> resources)	Creates an instance of a SimpleModule record class.

Method Summary

Modifier and Type	Method	Description
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.
Optional<String>	main()	Returns the value of the main record component.
SimpleModule	main(String mainClassName)
String	name()	Returns the value of the name record component.
static SimpleModule	of(String name)
List<Path>	resources()	Returns the value of the resources record component.
final String	toString()	Returns a string representation of this record class.
SimpleModule	withResourcePath(String first, String... more)
SimpleModule	withResourcePath(Path path)

Methods inherited from class java.lang.Object

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

Constructor Details

SimpleModule

public SimpleModule(String name,
 Optional<String> main,
 List<Path> resources)

Creates an instance of a SimpleModule record class.

Parameters:

name - the value for the name record component

main - the value for the main record component

resources - the value for the resources record component

Method Details

of

public static SimpleModule of(String name)

main

public SimpleModule main(String mainClassName)

withResourcePath

public SimpleModule withResourcePath(String first,
 String... more)

withResourcePath

public SimpleModule withResourcePath(Path path)

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 String name()

Returns the value of the name record component.

Returns:

the value of the name record component

main

public Optional<String> main()

Returns the value of the main record component.

Returns:

the value of the main record component

resources

public List<Path> resources()

Returns the value of the resources record component.

Returns:

the value of the resources record component