Module com.github.sormuras.bach

Package com.github.sormuras.bach.command

Record Class JarCommand

java.lang.Object

java.lang.Record

com.github.sormuras.bach.command.JarCommand

Record Components:

mode - The main operation mode like --create, --list, or --update.

file - Specifies the archive file name.

main - Specifies the entry point for standalone applications bundled into a JAR file.

verbose - Sends or prints verbose output to standard output.

additionals - Aggregates additional command-line arguments.

files - Specifies the classes and resources to operate on.

All Implemented Interfaces:

Command<JarCommand>

public record JarCommand(JarCommand.ModeOption mode, JarCommand.FileOption file, JarCommand.MainClassOption main, VerboseOption verbose, AdditionalArgumentsOption additionals, JarCommand.FilesOption files)
extends Record
implements Command<JarCommand>

The jar command creates an archive for classes and resources, and manipulates or restores individual classes or resources from an archive.

See Also:

• jar

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	JarCommand.FileOption	Archive file name option.
static final record	JarCommand.FilesOption	Directories and regular files option.
static final record	JarCommand.MainClassOption	Entry point for standalone applications option.
static final record	JarCommand.ModeOption	Main operation mode option.

Constructor Summary

Constructors

Constructor	Description
JarCommand()
JarCommand(JarCommand.ModeOption mode, JarCommand.FileOption file, JarCommand.MainClassOption main, VerboseOption verbose, AdditionalArgumentsOption additionals, JarCommand.FilesOption files)	Creates an instance of a JarCommand record class.

Method Summary

Modifier and Type	Method	Description
AdditionalArgumentsOption	additionals()	Returns the value of the additionals record component.
JarCommand	additionals(AdditionalArgumentsOption additionals)	Creates a new instance of the implementing class with the given option object.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
JarCommand.FileOption	file()	Returns the value of the file record component.
JarCommand	file(Path file)
JarCommand.FilesOption	files()	Returns the value of the files record component.
JarCommand	filesAdd(int version, Path path)
JarCommand	filesAdd(Path path)
final int	hashCode()	Returns a hash code value for this object.
JarCommand.MainClassOption	main()	Returns the value of the main record component.
JarCommand	main(String main)
JarCommand.ModeOption	mode()	Returns the value of the mode record component.
JarCommand	mode(String mode)
String	name()	Returns the name of the command.
JarCommand	option(Option option)	Creates a new instance of the implementing class with the given option object.
List<String>	toArguments()	Returns a list of all aggregated arguments.
final String	toString()	Returns a string representation of this record class.
VerboseOption	verbose()	Returns the value of the verbose record component.
JarCommand	verbose(Boolean verbose)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.sormuras.bach.Command

add, add, addAll, addAll, composing

Constructor Details

JarCommand

public JarCommand()

JarCommand

public JarCommand(JarCommand.ModeOption mode,
 JarCommand.FileOption file,
 JarCommand.MainClassOption main,
 VerboseOption verbose,
 AdditionalArgumentsOption additionals,
 JarCommand.FilesOption files)

Creates an instance of a JarCommand record class.

Parameters:

mode - the value for the mode record component

file - the value for the file record component

main - the value for the main record component

verbose - the value for the verbose record component

additionals - the value for the additionals record component

files - the value for the files record component

Method Details

name

public String name()

Description copied from interface: Command

Returns the name of the command.

Specified by:

name in interface Command<JarCommand>

Returns:

the name of the command

option

public JarCommand option(Option option)

Description copied from interface: Command

Creates a new instance of the implementing class with the given option object.

Specified by:

option in interface Command<JarCommand>

Parameters:

option - the option object to use

Returns:

a new instance of the implementing class

mode

public JarCommand mode(String mode)

file

public JarCommand file(Path file)

main

public JarCommand main(String main)

verbose

public JarCommand verbose(Boolean verbose)

additionals

public JarCommand additionals(AdditionalArgumentsOption additionals)

Description copied from interface: Command

Creates a new instance of the implementing class with the given option object.

Specified by:

additionals in interface Command<JarCommand>

Parameters:

additionals - the option object to use

Returns:

a new instance of the implementing class

See Also:

• Command.option(Option)

filesAdd

public JarCommand filesAdd(Path path)

filesAdd

public JarCommand filesAdd(int version,
 Path path)

toArguments

public List<String> toArguments()

Description copied from interface: Command

Returns a list of all aggregated arguments.

Specified by:

toArguments in interface Command<JarCommand>

Returns:

a list of all aggregated arguments

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.

mode

public JarCommand.ModeOption mode()

Returns the value of the mode record component.

Returns:

the value of the mode record component

file

public JarCommand.FileOption file()

Returns the value of the file record component.

Returns:

the value of the file record component

main

public JarCommand.MainClassOption main()

Returns the value of the main record component.

Returns:

the value of the main record component

verbose

public VerboseOption verbose()

Returns the value of the verbose record component.

Returns:

the value of the verbose record component

additionals

public AdditionalArgumentsOption additionals()

Returns the value of the additionals record component.

Specified by:

additionals in interface Command<JarCommand>

Returns:

the value of the additionals record component

files

public JarCommand.FilesOption files()

Returns the value of the files record component.

Returns:

the value of the files record component