Module com.github.sormuras.bach

Package com.github.sormuras.bach

Record Class Configuration

java.lang.Object

java.lang.Record

com.github.sormuras.bach.Configuration

public record Configuration(boolean verbose, boolean lenient, int timeout, Configuration.Pathing pathing, Configuration.Printing printing, Configuration.Tooling tooling, Options.ProjectOptions projectOptions)
extends Record

Global settings with nested topic-specific configurations.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	Configuration.Pathing	Path-related settings.
static final record	Configuration.Printing	Print-related settings and common PrintWriter objects.
static final record	Configuration.Tooling	ToolFinder-related and ToolProvider-related settings.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_PROJECT_NAME
static final String	DEFAULT_PROJECT_VERSION
static final String	EXTERNAL_MODULES_DIRECTORY
static final String	EXTERNAL_TOOL_LAYERS_DIRECTORY
static final String	EXTERNAL_TOOL_PROGRAM_ARGSFILE
static final String	EXTERNAL_TOOL_PROGRAMS_DIRECTORY
static final String	LOGBOOK_ARCHIVE_FILE
static final String	LOGBOOK_MARKDOWN_FILE
static final String	TIMESTAMP_PATTERN
static final String	WORKSPACE_DIRECTORY

Constructor Summary

Constructors

Constructor	Description
Configuration(boolean verbose, boolean lenient, int timeout, Configuration.Pathing pathing, Configuration.Printing printing, Configuration.Tooling tooling, Options.ProjectOptions projectOptions)	Creates an instance of a Configuration record class.

Method Summary

Modifier and Type	Method	Description
static String	computeDefaultProjectName()
static String	computeDefaultProjectName(Path directory)
static ModuleDescriptor.Version	computeDefaultProjectVersion()
static String	computeJarFileName(String module, ModuleDescriptor.Version version)
static Path	computeJavaExecutablePath(String name)
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.
boolean	lenient()	Returns the value of the lenient record component.
static Configuration	of()
static Configuration	of(Configuration.Pathing pathing, Configuration.Printing printing)
static Configuration	ofErrorsOnly(Path base)
Configuration.Pathing	pathing()	Returns the value of the pathing record component.
Configuration.Printing	printing()	Returns the value of the printing record component.
Options.ProjectOptions	projectOptions()	Returns the value of the projectOptions record component.
int	timeout()	Returns the value of the timeout record component.
Configuration.Tooling	tooling()	Returns the value of the tooling record component.
final String	toString()	Returns a string representation of this record class.
boolean	verbose()	Returns the value of the verbose record component.
Configuration	with(Options options)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_PROJECT_NAME

public static final String DEFAULT_PROJECT_NAME

See Also:

• Constant Field Values

DEFAULT_PROJECT_VERSION

public static final String DEFAULT_PROJECT_VERSION

See Also:

• Constant Field Values

EXTERNAL_MODULES_DIRECTORY

public static final String EXTERNAL_MODULES_DIRECTORY

See Also:

• Constant Field Values

EXTERNAL_TOOL_LAYERS_DIRECTORY

public static final String EXTERNAL_TOOL_LAYERS_DIRECTORY

See Also:

• Constant Field Values

EXTERNAL_TOOL_PROGRAMS_DIRECTORY

public static final String EXTERNAL_TOOL_PROGRAMS_DIRECTORY

See Also:

• Constant Field Values

EXTERNAL_TOOL_PROGRAM_ARGSFILE

public static final String EXTERNAL_TOOL_PROGRAM_ARGSFILE

See Also:

• Constant Field Values

LOGBOOK_ARCHIVE_FILE

public static final String LOGBOOK_ARCHIVE_FILE

See Also:

• Constant Field Values

LOGBOOK_MARKDOWN_FILE

public static final String LOGBOOK_MARKDOWN_FILE

See Also:

• Constant Field Values

TIMESTAMP_PATTERN

public static final String TIMESTAMP_PATTERN

See Also:

• Constant Field Values

WORKSPACE_DIRECTORY

public static final String WORKSPACE_DIRECTORY

See Also:

• Constant Field Values

Constructor Details

Configuration

public Configuration(boolean verbose,
 boolean lenient,
 int timeout,
 Configuration.Pathing pathing,
 Configuration.Printing printing,
 Configuration.Tooling tooling,
 Options.ProjectOptions projectOptions)

Creates an instance of a Configuration record class.

Parameters:

verbose - the value for the verbose record component

lenient - the value for the lenient record component

timeout - the value for the timeout record component

pathing - the value for the pathing record component

printing - the value for the printing record component

tooling - the value for the tooling record component

projectOptions - the value for the projectOptions record component

Method Details

computeDefaultProjectName

public static String computeDefaultProjectName()

computeDefaultProjectName

public static String computeDefaultProjectName(Path directory)

computeDefaultProjectVersion

public static ModuleDescriptor.Version computeDefaultProjectVersion()

computeJavaExecutablePath

public static Path computeJavaExecutablePath(String name)

computeJarFileName

public static String computeJarFileName(String module,
 ModuleDescriptor.Version version)

of

public static Configuration of()

ofErrorsOnly

public static Configuration ofErrorsOnly(Path base)

of

public static Configuration of(Configuration.Pathing pathing,
 Configuration.Printing printing)

with

public Configuration with(Options options)

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

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.

verbose

public boolean verbose()

Returns the value of the verbose record component.

Returns:

the value of the verbose record component

lenient

public boolean lenient()

Returns the value of the lenient record component.

Returns:

the value of the lenient record component

timeout

public int timeout()

Returns the value of the timeout record component.

Returns:

the value of the timeout record component

pathing

public Configuration.Pathing pathing()

Returns the value of the pathing record component.

Returns:

the value of the pathing record component

printing

public Configuration.Printing printing()

Returns the value of the printing record component.

Returns:

the value of the printing record component

tooling

public Configuration.Tooling tooling()

Returns the value of the tooling record component.

Returns:

the value of the tooling record component

projectOptions

public Options.ProjectOptions projectOptions()

Returns the value of the projectOptions record component.

Returns:

the value of the projectOptions record component