SoyProtoTypeImpl (Closure Templates)

java.lang.Object
- com.google.template.soy.types.proto.SoyProtoTypeImpl

All Implemented Interfaces:

SoyProtoType, SoyObjectType, SoyType
```
public final class SoyProtoTypeImpl
extends Object
implements SoyObjectType, SoyProtoType
```
A SoyType subclass which describes a protocol buffer type.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface SoyProtoTypeImpl.Value
Interface used to indicate that a value is a proto.
- Nested classes/interfaces inherited from interface com.google.template.soy.types.SoyType
  SoyType.Kind

Nested Classes
Modifier and Type	Class and Description
`static interface`	`SoyProtoTypeImpl.Value` Interface used to indicate that a value is a proto.

Constructor Summary

Constructors
Constructor and Description
`SoyProtoTypeImpl(SoyTypeRegistry typeRegistry, com.google.protobuf.Descriptors.Descriptor descriptor, Set<com.google.protobuf.Descriptors.FieldDescriptor> extensions)`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getDescriptorExpression()` For ParseInfo generation, return a string that represents the Java source expression for the static descriptor constant.
`String`	`getFieldAccessExpr(String fieldContainerExpr, String fieldName, SoyBackendKind backend)` 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.protobuf.Descriptors.FieldDescriptor`	`getFieldDescriptor(String fieldName)`
`com.google.common.collect.ImmutableSet<String>`	`getFieldNames()` Returns all the field names of this proto.
`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.
`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.
`boolean`	`isAssignableFrom(SoyType fromType)` 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.
`String`	`toString()`

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

- Constructor Detail
  - SoyProtoTypeImpl
```
public SoyProtoTypeImpl(SoyTypeRegistry typeRegistry,
                com.google.protobuf.Descriptors.Descriptor descriptor,
                Set<com.google.protobuf.Descriptors.FieldDescriptor> extensions)
```
- Method Detail
  - 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 fromType)
```
    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:
    fromType - 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
  - 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.
  - 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.
  - getFieldAccessExpr
```
public String getFieldAccessExpr(String fieldContainerExpr,
                        String fieldName,
                        SoyBackendKind backend)
```
    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.
    backend - Which backend we're generating code for.
    
    Returns:
    Expression used to access the field data.
  - getFieldDescriptor
```
public com.google.protobuf.Descriptors.FieldDescriptor getFieldDescriptor(String fieldName)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - 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.
  - getDescriptorExpression
```
public String getDescriptorExpression()
```
    Description copied from interface: SoyProtoType
    
    For ParseInfo generation, return a string that represents the Java source expression for the static descriptor constant.
    
    Specified by:
    
    getDescriptorExpression in interface SoyProtoType
    
    Returns:
    The Java source expression for this type's descriptor.
  - getFieldNames
```
public com.google.common.collect.ImmutableSet<String> getFieldNames()
```
    Returns all the field names of this proto.
    
    Specified by:
    
    getFieldNames in interface SoyObjectType

Class SoyProtoTypeImpl

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SoyProtoTypeImpl

Method Detail

getKind

isAssignableFrom

isInstance

javaType

getName

getFieldType

getNameForBackend

getFieldAccessExpr

getFieldDescriptor

toString

getFieldAccessImports

getDescriptorExpression

getFieldNames