Package ortus.boxlang.runtime.types

Record Class Argument

java.lang.Object

java.lang.Record

ortus.boxlang.runtime.types.Argument

Record Components:

required - Whether the argument is required

type - The type of the argument

name - The name of the argument

defaultValue - The default value of the argument

defaultExpression - The default value of the argument as a Lambda to be evaluated at runtime

annotations - Annotations for the argument

documentation - Documentation for the argument

All Implemented Interfaces:

Validatable

public record Argument(boolean required, String type, Key name, Object defaultValue, Argument.DefaultExpression defaultExpression, IStruct annotations, IStruct documentation, Set<Validator> validators)
extends Record
implements Validatable

Represents an argument to a function or BIF

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Argument.DefaultExpression

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ANY
static final String	ARRAY
static final String	BOOLEAN
static final String	CLOSURE
static final String	DATE
static final String	DATETIME
static final String	DOUBLE
static final String	FILE
static final String	FUNCTION
static final String	INTEGER
static final String	LAMBDA
static final String	LIST
static final String	LONG
static final String	MODIFIABLE_ARRAY
static final String	MODIFIABLE_QUERY
static final String	MODIFIABLE_STRUCT
static final String	NUMERIC
static final String	QUERY
static final String	STRING
static final String	STRUCT
static final String	STRUCT_LOOSE
static final String	UDF
static final String	XML

Constructor Summary

Constructors

Constructor	Description
Argument(boolean required, String type, Key name)
Argument(boolean required, String type, Key name, Object defaultValue)
Argument(boolean required, String type, Key name, Object defaultValue, Set<Validator> validators)
Argument(boolean required, String type, Key name, Object defaultValue, Argument.DefaultExpression defaultExpression, IStruct annotations, IStruct documentation)
Argument(boolean required, String type, Key name, Object defaultValue, Argument.DefaultExpression defaultExpression, IStruct annotations, IStruct documentation, Set<Validator> validators)	Creates an instance of a Argument record class.
Argument(boolean required, String type, Key name, Object defaultValue, IStruct annotations)
Argument(boolean required, String type, Key name, Object defaultValue, IStruct annotations, Set<Validator> validators)
Argument(boolean required, String type, Key name, Set<Validator> validators)
Argument(Key name)
Argument(Key name, Set<Validator> validators)

Method Summary

Modifier and Type	Method	Description
IStruct	annotations()	Returns the value of the annotations record component.
Argument.DefaultExpression	defaultExpression()	Returns the value of the defaultExpression record component.
Object	defaultValue()	Returns the value of the defaultValue record component.
IStruct	documentation()	Returns the value of the documentation record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Object	getDefaultValue(IBoxContext context)
boolean	hasDefaultValue()
final int	hashCode()	Returns a hash code value for this object.
Boolean	implementsSignature(Argument arg)
Key	name()	Returns the value of the name record component.
boolean	required()	Returns the value of the required record component.
String	signatureAsString()
final String	toString()	Returns a string representation of this record class.
String	type()	Returns the value of the type record component.
Set<Validator>	validators()	Returns the value of the validators record component.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ortus.boxlang.runtime.validation.Validatable

validate

Field Details

ANY

public static final String ANY

See Also:

• Constant Field Values

ARRAY

public static final String ARRAY

See Also:

• Constant Field Values

BOOLEAN

public static final String BOOLEAN

See Also:

• Constant Field Values

DATE

public static final String DATE

See Also:

• Constant Field Values

DATETIME

public static final String DATETIME

See Also:

• Constant Field Values

DOUBLE

public static final String DOUBLE

See Also:

• Constant Field Values

FILE

public static final String FILE

See Also:

• Constant Field Values

FUNCTION

public static final String FUNCTION

See Also:

• Constant Field Values

INTEGER

public static final String INTEGER

See Also:

• Constant Field Values

LIST

public static final String LIST

See Also:

• Constant Field Values

LONG

public static final String LONG

See Also:

• Constant Field Values

MODIFIABLE_ARRAY

public static final String MODIFIABLE_ARRAY

See Also:

• Constant Field Values

MODIFIABLE_STRUCT

public static final String MODIFIABLE_STRUCT

See Also:

• Constant Field Values

MODIFIABLE_QUERY

public static final String MODIFIABLE_QUERY

See Also:

• Constant Field Values

NUMERIC

public static final String NUMERIC

See Also:

• Constant Field Values

QUERY

public static final String QUERY

See Also:

• Constant Field Values

STRING

public static final String STRING

See Also:

• Constant Field Values

STRUCT

public static final String STRUCT

See Also:

• Constant Field Values

STRUCT_LOOSE

public static final String STRUCT_LOOSE

See Also:

• Constant Field Values

UDF

public static final String UDF

See Also:

• Constant Field Values

CLOSURE

public static final String CLOSURE

See Also:

• Constant Field Values

LAMBDA

public static final String LAMBDA

See Also:

• Constant Field Values

XML

public static final String XML

See Also:

• Constant Field Values

Constructor Details

Argument

public Argument(Key name)

Argument

public Argument(Key name,
 Set<Validator> validators)

Argument

public Argument(boolean required,
 String type,
 Key name)

Argument

public Argument(boolean required,
 String type,
 Key name,
 Set<Validator> validators)

Argument

public Argument(boolean required,
 String type,
 Key name,
 Object defaultValue)

Argument

public Argument(boolean required,
 String type,
 Key name,
 Object defaultValue,
 Set<Validator> validators)

Argument

public Argument(boolean required,
 String type,
 Key name,
 Object defaultValue,
 IStruct annotations)

Argument

public Argument(boolean required,
 String type,
 Key name,
 Object defaultValue,
 IStruct annotations,
 Set<Validator> validators)

Argument

public Argument(boolean required,
 String type,
 Key name,
 Object defaultValue,
 Argument.DefaultExpression defaultExpression,
 IStruct annotations,
 IStruct documentation)

Argument

public Argument(boolean required,
 String type,
 Key name,
 Object defaultValue,
 Argument.DefaultExpression defaultExpression,
 IStruct annotations,
 IStruct documentation,
 Set<Validator> validators)

Creates an instance of a Argument record class.

Parameters:

required - the value for the required record component

type - the value for the type record component

name - the value for the name record component

defaultValue - the value for the defaultValue record component

defaultExpression - the value for the defaultExpression record component

annotations - the value for the annotations record component

documentation - the value for the documentation record component

validators - the value for the validators record component

Method Details

getDefaultValue

public Object getDefaultValue(IBoxContext context)

hasDefaultValue

public boolean hasDefaultValue()

implementsSignature

public Boolean implementsSignature(Argument arg)

signatureAsString

public String signatureAsString()

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.

required

public boolean required()

Returns the value of the required record component.

Returns:

the value of the required record component

type

public String type()

Returns the value of the type record component.

Specified by:

type in interface Validatable

Returns:

the value of the type record component

name

public Key name()

Returns the value of the name record component.

Specified by:

name in interface Validatable

Returns:

the value of the name record component

defaultValue

public Object defaultValue()

Returns the value of the defaultValue record component.

Specified by:

defaultValue in interface Validatable

Returns:

the value of the defaultValue record component

defaultExpression

public Argument.DefaultExpression defaultExpression()

Returns the value of the defaultExpression record component.

Returns:

the value of the defaultExpression record component

annotations

public IStruct annotations()

Returns the value of the annotations record component.

Returns:

the value of the annotations record component

documentation

public IStruct documentation()

Returns the value of the documentation record component.

Returns:

the value of the documentation record component

validators

public Set<Validator> validators()

Returns the value of the validators record component.

Specified by:

validators in interface Validatable

Returns:

the value of the validators record component