Record Class ArgumentList

java.lang.Object

java.lang.Record

org.aksw.shellgebra.shim.core.ArgumentList

public record ArgumentList(List<CmdArg> args)
extends Record

A model that captures structured arguments. This record is used by tool shims to represent the parsed arguments. Arguments can be e.g. file paths or sub commands. Note, that redirects as arguments should be avoided: Redirects are handled by the shell and not by the command.

Constructor Summary

Constructors

Constructor	Description
ArgumentList(List<CmdArg> args)	Creates an instance of a ArgumentList record class.

Method Summary

Modifier and Type	Method	Description
List<CmdArg>	args()	Returns the value of the args record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
List<CmdArg>	getRealArgs()	Get non-redirect arguments.
List<CmdRedirect>	getRedirects()	Get redirect arguments.
final int	hashCode()	Returns a hash code value for this object.
static ArgumentList	of(List<CmdArg> args)
static ArgumentList	of(CmdArg... args)
static ArgumentList	ofLiterals(List<String> args)
int	size()
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

ArgumentList

public ArgumentList(List<CmdArg> args)

Creates an instance of a ArgumentList record class.

Parameters:

args - the value for the args record component

Method Details

size

public int size()

of

public static ArgumentList of(CmdArg... args)

of

public static ArgumentList of(List<CmdArg> args)

ofLiterals

public static ArgumentList ofLiterals(List<String> args)

getRedirects

public List<CmdRedirect> getRedirects()

Get redirect arguments.

getRealArgs

public List<CmdArg> getRealArgs()

Get non-redirect 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.

args

public List<CmdArg> args()

Returns the value of the args record component.

Returns:

the value of the args record component