UnionType (Closure Templates)

java.lang.Object
- com.google.template.soy.types.aggregate.UnionType

All Implemented Interfaces:

SoyType
```
public final class UnionType
extends Object
implements SoyType
```
Type representing a set of possible alternative types.

Nested Class Summary
- Nested classes/interfaces inherited from interface com.google.template.soy.types.SoyType
  SoyType.Kind

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object other)`
`SoyType.Kind`	`getKind()` Returns what kind of type this is.
`Set<SoyType>`	`getMembers()` Return the set of types contained in this union.
`int`	`hashCode()`
`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.
`boolean`	`isNullable()` Returns true if the union includes the null type.
`Class<? extends SoyValue>`	`javaType()` Returns the java class for the the SoyValue subclass that is used to represent this type.
`static SoyType`	`of(Collection<SoyType> members)` Create a union from a collection of types.
`static SoyType`	`of(SoyType... members)` Convenience method for creating unions.
`SoyType`	`removeNullability()` Returns a Soy type that is equivalent to this one but with 'null' removed.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - of
```
public static SoyType of(SoyType... members)
```
    Convenience method for creating unions.
    
    Parameters:
    members - Member types of the union.
    
    Returns:
    Union of those types. If there is exactly one distinct type in members, then this will not be a UnionType.
  - of
```
public static SoyType of(Collection<SoyType> members)
```
    Create a union from a collection of types.
    
    Parameters:
    members - Member types of the union.
    
    Returns:
    Union of those types. If there is exactly one distinct type in members, then this will not be a UnionType.
  - getKind
```
public SoyType.Kind getKind()
```
    Description copied from interface: SoyType
    
    Returns what kind of type this is.
    
    Specified by:
    
    getKind in interface SoyType
  - getMembers
```
public Set<SoyType> getMembers()
```
    Return the set of types contained in this union.
  - isAssignableFrom
```
public boolean isAssignableFrom(SoyType srcType)
```
    Description copied from interface: SoyType
    
    Returns true if a parameter or field of this type can be assigned from a value of srcType.
    
    Specified by:
    
    isAssignableFrom in interface SoyType
    
    Parameters:
    srcType - The type of the incoming value.
    
    Returns:
    True if the assignment is valid.
  - isInstance
```
public boolean isInstance(SoyValue value)
```
    Description copied from interface: SoyType
    
    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.
    
    Specified by:
    
    isInstance in interface SoyType
    
    Parameters:
    value - The value to test.
    
    Returns:
    True if the value is an instance of this type.
  - javaType
```
public Class<? extends SoyValue> javaType()
```
    Description copied from interface: SoyType
    
    Returns the java class for the the SoyValue subclass that is used to represent this type.
    
    Specified by:
    
    javaType in interface SoyType
  - isNullable
```
public boolean isNullable()
```
    Returns true if the union includes the null type.
  - removeNullability
```
public SoyType removeNullability()
```
    Returns a Soy type that is equivalent to this one but with 'null' removed.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class UnionType

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.template.soy.types.SoyType

Method Summary

Methods inherited from class java.lang.Object

Method Detail

of

of

getKind

getMembers

isAssignableFrom

isInstance

javaType

isNullable

removeNullability

toString

equals

hashCode