Package software.amazon.smithy.rulesengine.language.evaluation.type

Interface Type

All Known Implementing Classes:

AnyType, ArrayType, BooleanType, EmptyType, EndpointType, IntegerType, OptionalType, RecordType, StringType, TupleType

public interface Type

Types used to construct conditions out of values in the rules engine.

Method Summary

Modifier and Type	Method	Description
static AnyType	anyType()
static ArrayType	arrayType(Type inner)
static BooleanType	booleanType()
static EmptyType	emptyType()
static EndpointType	endpointType()
default AnyType	expectAnyType()
default ArrayType	expectArrayType()
default BooleanType	expectBooleanType()
default EmptyType	expectEmptyType()
default EndpointType	expectEndpointType()
default IntegerType	expectIntegerType()
default OptionalType	expectOptionalType()
default RecordType	expectRecordType(String message)
default StringType	expectStringType()
default TupleType	expectTupleType()
static Type	fromParameterType(ParameterType parameterType)
static IntegerType	integerType()
default boolean	isA(Type type)	Returns true if this type matches the target type.
static OptionalType	optionalType(Type type)
default Type	provenTruthy()	When used in the context of a condition, the condition can only match if the value was truthful.
static RecordType	recordType(Map<Identifier,Type> inner)
static StringType	stringType()
static TupleType	tupleType(List<Type> members)

Method Details

isA

default boolean isA(Type type)

Returns true if this type matches the target type.

Parameters:

type - the target type to match.

Returns:

true if the types match, false otherwise.

provenTruthy

default Type provenTruthy()

When used in the context of a condition, the condition can only match if the value was truthful. This means that a certain expression can be a different type, for example, OptionalType<T> will become T.

Returns:

The type, given that it has been proven truthy

fromParameterType

static Type fromParameterType(ParameterType parameterType)

anyType

static AnyType anyType()

arrayType

static ArrayType arrayType(Type inner)

booleanType

static BooleanType booleanType()

emptyType

static EmptyType emptyType()

endpointType

static EndpointType endpointType()

integerType

static IntegerType integerType()

optionalType

static OptionalType optionalType(Type type)

recordType

static RecordType recordType(Map<Identifier,Type> inner)

stringType

static StringType stringType()

tupleType

static TupleType tupleType(List<Type> members)

expectAnyType

default AnyType expectAnyType()
                       throws InnerParseError

Throws:

InnerParseError

expectArrayType

default ArrayType expectArrayType()
                           throws InnerParseError

Throws:

InnerParseError

expectBooleanType

default BooleanType expectBooleanType()
                               throws InnerParseError

Throws:

InnerParseError

expectEmptyType

default EmptyType expectEmptyType()
                           throws InnerParseError

Throws:

InnerParseError

expectEndpointType

default EndpointType expectEndpointType()
                                 throws InnerParseError

Throws:

InnerParseError

expectIntegerType

default IntegerType expectIntegerType()
                               throws InnerParseError

Throws:

InnerParseError

expectOptionalType

default OptionalType expectOptionalType()
                                 throws InnerParseError

Throws:

InnerParseError

expectRecordType

default RecordType expectRecordType(String message)
                             throws InnerParseError

Throws:

InnerParseError

expectStringType

default StringType expectStringType()
                             throws InnerParseError

Throws:

InnerParseError

expectTupleType

default TupleType expectTupleType()
                           throws InnerParseError

Throws:

InnerParseError