Module com.github.sormuras.bach

Package com.github.sormuras.bach

Record Class Options

java.lang.Object

java.lang.Record

com.github.sormuras.bach.Options

public record Options(Options.MainOptions forMain, Options.ConfigurationOptions forConfiguration, Options.ProjectOptions forProject, List<String> unhandledArguments)
extends Record

All well-known options, usually parsed from command-line arguments.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	Options.ConfigurationOptions	A group of optional components used as global settings of a Configuration instance.
static final record	Options.MainOptions	A group of optional components used by the main program.
static final record	Options.ProjectOptions	A group of optional components used when building a project model instance.

Constructor Summary

Constructors

Constructor	Description
Options(Options.MainOptions forMain, Options.ConfigurationOptions forConfiguration, Options.ProjectOptions forProject, List<String> unhandledArguments)	Creates an instance of a Options record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Options.ConfigurationOptions	forConfiguration()	Returns the value of the forConfiguration record component.
Options.MainOptions	forMain()	Returns the value of the forMain record component.
Options.ProjectOptions	forProject()	Returns the value of the forProject record component.
final int	hashCode()	Returns a hash code value for this object.
static Options	parse(String... args)	Parses an array of strings in command-line style into an options instance.
static Options	parse(List<String> args)
final String	toString()	Returns a string representation of this record class.
List<String>	unhandledArguments()	Returns the value of the unhandledArguments record component.

Methods inherited from class java.lang.Object

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

Constructor Details

Options

public Options(Options.MainOptions forMain,
 Options.ConfigurationOptions forConfiguration,
 Options.ProjectOptions forProject,
 List<String> unhandledArguments)

Creates an instance of a Options record class.

Parameters:

forMain - the value for the forMain record component

forConfiguration - the value for the forConfiguration record component

forProject - the value for the forProject record component

unhandledArguments - the value for the unhandledArguments record component

Method Details

parse

public static Options parse(String... args)

Parses an array of strings in command-line style into an options instance.

parse

public static Options parse(List<String> args)

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.

forMain

public Options.MainOptions forMain()

Returns the value of the forMain record component.

Returns:

the value of the forMain record component

forConfiguration

public Options.ConfigurationOptions forConfiguration()

Returns the value of the forConfiguration record component.

Returns:

the value of the forConfiguration record component

forProject

public Options.ProjectOptions forProject()

Returns the value of the forProject record component.

Returns:

the value of the forProject record component

unhandledArguments

public List<String> unhandledArguments()

Returns the value of the unhandledArguments record component.

Returns:

the value of the unhandledArguments record component