com.google.template.soy.types

Class SoyTypes

java.lang.Object

com.google.template.soy.types.SoyTypes

public final class SoyTypes
extends Object

Utility methods for operating on SoyType instances.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoyTypes.SoyTypeArithmeticOperator Type resolver for all arithmetic operators (except plus operator).
static interface	SoyTypes.SoyTypeBinaryOperator A type resolver interface that can be passed into getSoyTypeForBinaryOperator method.
static class	SoyTypes.SoyTypeComparisonOp Type resolver for For <, >, <=, and >= operators.
static class	SoyTypes.SoyTypeEqualComparisonOp Type resolver for equal (==) and not equal (!=) operators.
static class	SoyTypes.SoyTypePlusOperator Type resolver for plus operators.

Field Summary

Fields

Modifier and Type	Field and Description
static SoyType	NUMBER_TYPE Shared constant for the 'number' type.

Constructor Summary

Constructors

Constructor and Description
SoyTypes()

Method Summary

Modifier and Type	Method and Description
static SoyType	computeLowestCommonType(SoyTypeRegistry typeRegistry, Collection<SoyType> types) Compute the most specific type that is assignable from all types within a collection.
static SoyType	computeLowestCommonType(SoyTypeRegistry typeRegistry, SoyType t0, SoyType t1) Compute the most specific type that is assignable from both t0 and t1.
static com.google.common.base.Optional<SoyType>	computeLowestCommonTypeArithmetic(SoyType t0, SoyType t1) Compute the most specific type that is assignable from both t0 and t1, taking into account arithmetic promotions - that is, converting int to float if needed.
static SoyType	getSoyTypeForBinaryOperator(SoyType t0, SoyType t1, SoyTypes.SoyTypeBinaryOperator operator) Returns the SoyType that should be the result of a binary operator.
static boolean	isNullable(SoyType type)
static boolean	isNumericOrUnknown(SoyType type)
static boolean	isNumericPrimitive(SoyType type) Returns true if the input type is a numeric primitive type, such as int, float, proto enum, and number.
static SoyType	makeNullable(SoyType type)
static SoyType	removeNull(SoyType type)
static SoyType	tryRemoveNull(SoyType soyType) If the type is nullable, makes it non-nullable.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NUMBER_TYPE

public static final SoyType NUMBER_TYPE

Shared constant for the 'number' type.

Constructor Detail

SoyTypes

public SoyTypes()

Method Detail

isNumericPrimitive

public static boolean isNumericPrimitive(SoyType type)

Returns true if the input type is a numeric primitive type, such as int, float, proto enum, and number.

removeNull

public static SoyType removeNull(SoyType type)

tryRemoveNull

public static SoyType tryRemoveNull(SoyType soyType)

If the type is nullable, makes it non-nullable.

If the type is the null type, then it returns the null type.

makeNullable

public static SoyType makeNullable(SoyType type)

isNullable

public static boolean isNullable(SoyType type)

isNumericOrUnknown

public static boolean isNumericOrUnknown(SoyType type)

computeLowestCommonType

public static SoyType computeLowestCommonType(SoyTypeRegistry typeRegistry,
                                              SoyType t0,
                                              SoyType t1)

Compute the most specific type that is assignable from both t0 and t1.

Parameters:

typeRegistry - Type registry.

t0 - A type.

t1 - Another type.

Returns:

A type that is assignable from both t0 and t1.

computeLowestCommonType

public static SoyType computeLowestCommonType(SoyTypeRegistry typeRegistry,
                                              Collection<SoyType> types)

Compute the most specific type that is assignable from all types within a collection.

Parameters:

typeRegistry - Type registry.

types - List of types.

Returns:

A type that is assignable from all of the listed types.

computeLowestCommonTypeArithmetic

public static com.google.common.base.Optional<SoyType> computeLowestCommonTypeArithmetic(SoyType t0,
                                                                                         SoyType t1)

Compute the most specific type that is assignable from both t0 and t1, taking into account arithmetic promotions - that is, converting int to float if needed.

Parameters:

t0 - A type.

t1 - Another type.

Returns:

A type that is assignable from both t0 and t1 or absent if the types are not arithmetic meaning a subtype of 'number' or unknown.

getSoyTypeForBinaryOperator

@Nullable
public static SoyType getSoyTypeForBinaryOperator(SoyType t0,
                                                            SoyType t1,
                                                            SoyTypes.SoyTypeBinaryOperator operator)

Returns the SoyType that should be the result of a binary operator.

This method is mostly for handling UnionType instances. For primitive soy types, the logic should be defined in the SoyTypeBinaryOperator. Recursion is used for collecting all possible combinations if any of the operands is UnionType. This method will return null if any of the combinations is incompatible (the operator returns null).