SoyType (Closure Templates)

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

All Known Subinterfaces:

SoyEnumType, SoyObjectType

All Known Implementing Classes:

AnyType, BoolType, ErrorType, FloatType, IntType, ListType, MapType, NullType, RecordType, SanitizedType, SanitizedType.AttributesType, SanitizedType.CssType, SanitizedType.HtmlType, SanitizedType.JsType, SanitizedType.TrustedResourceUriType, SanitizedType.UriType, SoyProtoTypeImpl, StringType, UnionType, UnknownType
```
public interface SoyType
```
Interface for all classes that describe a data type in Soy. These types are used to determine what kinds of values can be bound to a template or function parameter.
Note that this type hierarchy only describes types that are visible from a template author's perspective. Actual Soy values may have types which fall outside this hierarchy. An example is Futures - a SoyValue may contain a future of a type, but since the future is always resolved before the value is used, the future type is invisible as far as the template is concerned.
All type objects are immutable.
Important: Do not use outside of Soy code (treat as superpackage-private).

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class SoyType.Kind
Enum that identifies the kind of type this is.

Method Summary

Methods
Modifier and Type	Method and Description
`SoyType.Kind`	`getKind()` Returns what kind of type this is.
`boolean`	`isAssignableFrom(SoyType srcType)` Returns true if a parameter or field of this type can be assigned from a value of `srcType`.
`boolean`	`isInstance(SoyValue value)` Returns true if the given value is an instance of this type.
`Class<? extends SoyValue>`	`javaType()` Returns the java class for the the SoyValue subclass that is used to represent this type.

- Method Detail
  - getKind
```
SoyType.Kind getKind()
```
    Returns what kind of type this is.
  - isAssignableFrom
```
boolean isAssignableFrom(SoyType srcType)
```
    Returns true if a parameter or field of this type can be assigned from a value of srcType.
    
    Parameters:
    srcType - The type of the incoming value.
    
    Returns:
    True if the assignment is valid.
  - isInstance
```
boolean isInstance(SoyValue value)
```
    Returns true if the given value is an instance of this type. For generic types, this only checks the overall shape of the type (list, map, etc) since Java type erasure does not allow the type parameters to be checked. Also, in some cases the "instanceof" test may be defined somewhat loosely - for example, sanitized types may be considered instances of type string, since they are usable in any context where a string is usable, even though internally they are not implemented as subclasses of string. This test does not take into account automatic coercions, such as converting to string or boolean.
    
    Parameters:
    value - The value to test.
    
    Returns:
    True if the value is an instance of this type.
  - javaType
```
Class<? extends SoyValue> javaType()
```
    Returns the java class for the the SoyValue subclass that is used to represent this type.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method