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

Class Parameters

java.lang.Object

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

All Implemented Interfaces:

Iterable<Parameter>, FromSourceLocation, ToNode, ToSmithyBuilder<Parameters>

public final class Parameters
extends Object
implements FromSourceLocation, ToNode, ToSmithyBuilder<Parameters>, Iterable<Parameter>

An iterable container for Parameters defined in a rule-set.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Parameters.Builder	A builder used to create a Parameters class.

Method Summary

Modifier and Type	Method	Description
static Parameters.Builder	builder()	Builder to create a Parameters instance.
boolean	equals(Object o)
void	forEach(Consumer<? super Parameter> action)
static Parameters	fromNode(ObjectNode node)	Creates a Parameters instance from the given Node information.
Optional<Parameter>	get(Identifier name)	Gets the parameter for the given name.
SourceLocation	getSourceLocation()	Gets the source location of a value.
int	hashCode()
Iterator<Parameter>	iterator()
Spliterator<Parameter>	spliterator()
Parameters.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
Node	toNode()	Converts a value to a Node.
String	toString()
void	writeToScope(Scope<Type> scope)	Writes the parameters in this collection to the given scope.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static Parameters.Builder builder()

Builder to create a Parameters instance.

Returns:

returns a new Builder.

fromNode

public static Parameters fromNode(ObjectNode node)
                           throws RuleError

Creates a Parameters instance from the given Node information.

Parameters:

node - the node to deserialize.

Returns:

the created Parameters.

Throws:

RuleError

writeToScope

public void writeToScope(Scope<Type> scope)

Writes the parameters in this collection to the given scope.

Parameters:

scope - the scope

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.

get

public Optional<Parameter> get(Identifier name)

Gets the parameter for the given name.

Returns:

returns an optional containing the parameter if present, empty otherwise.

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.

toBuilder

public Parameters.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<Parameters>

Returns:

a builder for type T

iterator

public Iterator<Parameter> iterator()

Specified by:

iterator in interface Iterable<Parameter>

forEach

public void forEach(Consumer<? super Parameter> action)

Specified by:

forEach in interface Iterable<Parameter>

spliterator

public Spliterator<Parameter> spliterator()

Specified by:

spliterator in interface Iterable<Parameter>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object