RecordType (Closure Templates)

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

All Implemented Interfaces:

SoyObjectType, SoyType
```
public final class RecordType
extends Object
implements SoyObjectType
```
Dict type - classic dictionary type with string keys. Only works with field (dot) access.
Important: Do not use outside of Soy code (treat as superpackage-private).

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)`
`String`	`getFieldAccessExpr(String fieldContainerExpr, String fieldName, SoyBackendKind backendKind)` Return the expression used to access the value of the field, for a given output context.
`com.google.common.collect.ImmutableSet<String>`	`getFieldAccessImports(String fieldName, SoyBackendKind backend)` In some cases, `accessing a field` requires importing symbols into the generated code (example being protobuf extension fields which require importing the extension type).
`com.google.common.collect.ImmutableSet<String>`	`getFieldNames()` Return all the possible field names that can be referenced from this ObjectType.
`SoyType`	`getFieldType(String fieldName)` Return the data type of the field with the given name; If there's no such field, then return `null`.
`SoyType.Kind`	`getKind()` Returns what kind of type this is.
`com.google.common.collect.ImmutableSortedMap<String,SoyType>`	`getMembers()` Return the members of this record type.
`String`	`getName()` Return the fully-qualified name of this object type.
`String`	`getNameForBackend(SoyBackendKind backend)` Return the fully-qualified name of this type for a given output context.
`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.
`Class<? extends SoyValue>`	`javaType()` Returns the java class for the the SoyValue subclass that is used to represent this type.
`static RecordType`	`of(Map<String,? extends SoyType> members)`
`String`	`toString()`

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

- Method Detail
  - of
```
public static RecordType of(Map<String,? extends SoyType> members)
```
  - getKind
```
public SoyType.Kind getKind()
```
    Description copied from interface: SoyType
    
    Returns what kind of type this is.
    
    Specified by:
    
    getKind in interface SoyType
  - 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
  - getName
```
public String getName()
```
    Description copied from interface: SoyObjectType
    
    Return the fully-qualified name of this object type.
    
    Specified by:
    
    getName in interface SoyObjectType
  - getMembers
```
public com.google.common.collect.ImmutableSortedMap<String,SoyType> getMembers()
```
    Return the members of this record type.
  - getNameForBackend
```
public String getNameForBackend(SoyBackendKind backend)
```
    Description copied from interface: SoyObjectType
    
    Return the fully-qualified name of this type for a given output context.
    
    Specified by:
    
    getNameForBackend in interface SoyObjectType
    
    Parameters:
    backend - Which backend we're generating code for.
  - getFieldType
```
public SoyType getFieldType(String fieldName)
```
    Description copied from interface: SoyObjectType
    
    Return the data type of the field with the given name; If there's no such field, then return null.
    
    Specified by:
    
    getFieldType in interface SoyObjectType
    
    Parameters:
    fieldName - The name of the field.
    
    Returns:
    The field type, or null.
  - getFieldNames
```
public com.google.common.collect.ImmutableSet<String> getFieldNames()
```
    Description copied from interface: SoyObjectType
    
    Return all the possible field names that can be referenced from this ObjectType.
    
    Specified by:
    
    getFieldNames in interface SoyObjectType
  - getFieldAccessExpr
```
public String getFieldAccessExpr(String fieldContainerExpr,
                        String fieldName,
                        SoyBackendKind backendKind)
```
    Description copied from interface: SoyObjectType
    
    Return the expression used to access the value of the field, for a given output context.
    
    Specified by:
    
    getFieldAccessExpr in interface SoyObjectType
    
    Parameters:
    fieldContainerExpr - An expression that evaluates to the container of the named field. This expression may have any operator precedence that binds more tightly than unary operators.
    fieldName - Name of the field.
    backendKind - Which backend we're generating code for.
    
    Returns:
    Expression used to access the field data.
  - getFieldAccessImports
```
public com.google.common.collect.ImmutableSet<String> getFieldAccessImports(String fieldName,
                                                                   SoyBackendKind backend)
```
    Description copied from interface: SoyObjectType
    
    In some cases, accessing a field requires importing symbols into the generated code (example being protobuf extension fields which require importing the extension type). If this field requires imports, then this method will return the strings representing the symbol needed to import. Otherwise, returns the empty set.
    
    Specified by:
    
    getFieldAccessImports in interface SoyObjectType
    
    Parameters:
    fieldName - The name of the field being accessed.
    backend - Which backend we're generating code for.
    
    Returns:
    String Symbols in the backend's output language.
  - 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 RecordType

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

getKind

isAssignableFrom

isInstance

javaType

getName

getMembers

getNameForBackend

getFieldType

getFieldNames

getFieldAccessExpr

getFieldAccessImports

toString

equals

hashCode