Module com.github.sormuras.bach

Package com.github.sormuras.bach

Record Class Project

java.lang.Object

java.lang.Record

com.github.sormuras.bach.Project

public record Project(ProjectName name, ProjectVersion version, ProjectSpaces spaces, ProjectExternals externals)
extends Record

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Project.Component
static interface	Project.Operator

Constructor Summary

Constructors

Constructor	Description
Project(ProjectName name, ProjectVersion version, ProjectSpaces spaces, ProjectExternals externals)	Creates an instance of a Project record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
ProjectExternals	externals()	Returns the value of the externals record component.
final int	hashCode()	Returns a hash code value for this object.
ProjectName	name()	Returns the value of the name record component.
static Project	of(String name, ModuleDescriptor.Version version)
static Project	of(String name, String version)
ProjectSpace	space(String name)
ProjectSpaces	spaces()	Returns the value of the spaces record component.
String	toNameAndVersion()
final String	toString()	Returns a string representation of this record class.
ProjectVersion	version()	Returns the value of the version record component.
Project	with(Options options)
Project	with(Options.ProjectOptions options)
Project	with(Project.Component component)
Project	withExternals(ProjectExternals.Operator operator)
Project	withModuleTweak(String spaceName, String moduleName, DeclaredModule.Operator operator)
Project	withName(String name)
Project	withSpaces(ProjectSpaces.Operator operator)
Project	withVersion(ModuleDescriptor.Version version)
Project	withVersion(String version)

Methods inherited from class java.lang.Object

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

Constructor Details

Project

public Project(ProjectName name,
 ProjectVersion version,
 ProjectSpaces spaces,
 ProjectExternals externals)

Creates an instance of a Project record class.

Parameters:

name - the value for the name record component

version - the value for the version record component

spaces - the value for the spaces record component

externals - the value for the externals record component

Method Details

space

public ProjectSpace space(String name)

toNameAndVersion

public String toNameAndVersion()

of

public static Project of(String name,
 String version)

of

public static Project of(String name,
 ModuleDescriptor.Version version)

with

public Project with(Project.Component component)

with

public Project with(Options options)

with

public Project with(Options.ProjectOptions options)

withName

public Project withName(String name)

withVersion

public Project withVersion(String version)

withVersion

public Project withVersion(ModuleDescriptor.Version version)

withSpaces

public Project withSpaces(ProjectSpaces.Operator operator)

withExternals

public Project withExternals(ProjectExternals.Operator operator)

withModuleTweak

public Project withModuleTweak(String spaceName,
 String moduleName,
 DeclaredModule.Operator operator)

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

Returns the value of the name record component.

Returns:

the value of the name record component

version

public ProjectVersion version()

Returns the value of the version record component.

Returns:

the value of the version record component

spaces

public ProjectSpaces spaces()

Returns the value of the spaces record component.

Returns:

the value of the spaces record component

externals

public ProjectExternals externals()

Returns the value of the externals record component.

Returns:

the value of the externals record component