Package software.amazon.smithy.rulesengine.language.syntax.parameters

Class Parameter

java.lang.Object

software.amazon.smithy.rulesengine.language.syntax.parameters.Parameter

All Implemented Interfaces:

FromSourceLocation, ToNode, ToSmithyBuilder<Parameter>

public final class Parameter
extends java.lang.Object
implements ToSmithyBuilder<Parameter>, FromSourceLocation, ToNode

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Parameter.Builder
static class	Parameter.Deprecated

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT
static java.lang.String	DEPRECATED
static java.lang.String	DOCUMENTATION
static java.lang.String	TYPE

Method Summary

Modifier and Type	Method	Description
static Parameter.Builder	builder()
Function	equal(boolean b)	Provides a function comparing this parameter to a boolean value.
Function	equal(Expression expression)	Provides a function comparing this parameter to expression.
boolean	equals(java.lang.Object o)
static Parameter	fromNode(StringNode name, ObjectNode node)
java.util.Optional<java.lang.String>	getBuiltIn()
java.util.Optional<Value>	getDefault()	The default value for this Parameter.
java.util.Optional<Value>	getDefaultValue()
java.util.Optional<Parameter.Deprecated>	getDeprecated()
java.util.Optional<java.lang.String>	getDocumentation()
Identifier	getName()
SourceLocation	getSourceLocation()	Gets the source location of a value.
ParameterType	getType()
java.util.Optional<Value>	getValue()
int	hashCode()
boolean	isBuiltIn()
boolean	isRequired()
java.lang.String	template()
Parameter.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
Expression	toExpression()	Provides a reference to this parameter as an expression.
Node	toNode()	Converts a value to a Node.
java.lang.String	toString()
Type	toType()

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

DEPRECATED

public static final java.lang.String DEPRECATED

See Also:

Constant Field Values

DOCUMENTATION

public static final java.lang.String DOCUMENTATION

See Also:

Constant Field Values

DEFAULT

public static final java.lang.String DEFAULT

See Also:

Constant Field Values

Method Detail

fromNode

public static Parameter fromNode(StringNode name,
                                 ObjectNode node)
                          throws RuleError

Throws:

RuleError

builder

public static Parameter.Builder builder()

getBuiltIn

public java.util.Optional<java.lang.String> getBuiltIn()

getDefaultValue

public java.util.Optional<Value> getDefaultValue()

getSourceLocation

public SourceLocation getSourceLocation()

Description copied from interface: FromSourceLocation

Gets the source location of a value.

Specified by:

getSourceLocation in interface FromSourceLocation

Returns:

Returns the source location of the value.

getDeprecated

public java.util.Optional<Parameter.Deprecated> getDeprecated()

isRequired

public boolean isRequired()

getType

public ParameterType getType()

toType

public Type toType()

getName

public Identifier getName()

isBuiltIn

public boolean isBuiltIn()

getValue

public java.util.Optional<Value> getValue()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toBuilder

public Parameter.Builder toBuilder()

Description copied from interface: ToSmithyBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToSmithyBuilder<Parameter>

Returns:

a builder for type T

template

public java.lang.String template()

toNode

public Node toNode()

Description copied from interface: ToNode

Converts a value to a Node.

Specified by:

toNode in interface ToNode

Returns:

Returns the creates Node.

toExpression

public Expression toExpression()

Provides a reference to this parameter as an expression.

Returns:

the reference to the parameter.

equal

public Function equal(boolean b)

Provides a function comparing this parameter to a boolean value.

Parameters:

b - the boolean value to compare the parameter to.

Returns:

the BooleanEquals function comparing the parameter.

equal

public Function equal(Expression expression)

Provides a function comparing this parameter to expression.

Parameters:

expression - the expression.

Returns:

the BooleanEquals function comparing the parameter.

getDocumentation

public java.util.Optional<java.lang.String> getDocumentation()

getDefault

public java.util.Optional<Value> getDefault()

The default value for this Parameter.

Returns:

The value. This value must match the type of this parameter.