com.google.template.soy.types

Class SoyTypeRegistry

java.lang.Object

com.google.template.soy.types.SoyTypeRegistry

public class SoyTypeRegistry
extends Object

Registry of types which can be looked up by name.

Important: Do not use outside of Soy code (treat as superpackage-private).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoyTypeRegistry.Builder Helper class that assists in the construction of SoyTypeProviders.

Field Summary

Fields

Modifier and Type	Field and Description
static SoyTypeRegistry	DEFAULT_UNKNOWN A type registry that defaults all unknown types to the 'unknown' type.

Constructor Summary

Constructors

Constructor and Description
SoyTypeRegistry()

Method Summary

Modifier and Type	Method and Description
String	findTypeWithMatchingNamespace(String prefix) Finds a type whose top-level namespace is a specified prefix, or null if there are none.
LegacyObjectMapType	getOrCreateLegacyObjectMapType(SoyType keyType, SoyType valueType) Factory function which creates a legacy object map type, given a key and value type.
ListType	getOrCreateListType(SoyType elementType) Factory function which creates a list type, given an element type.
MapType	getOrCreateMapType(SoyType keyType, SoyType valueType) Factory function which creates a map type, given a key and value type.
RecordType	getOrCreateRecordType(Map<String,SoyType> fields) Factory function which creates a record type, given a map of fields.
SoyType	getOrCreateType(TypeNode node, ErrorReporter errorReporter) Converts a TypeNode into a SoyType.
SoyType	getOrCreateUnionType(Collection<SoyType> members) Factory function which creates a union type, given the member types.
SoyType	getOrCreateUnionType(SoyType... members) Factory function which creates a union type, given the member types.
SoyType	getType(String typeName) Look up a type by name.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_UNKNOWN

public static final SoyTypeRegistry DEFAULT_UNKNOWN

A type registry that defaults all unknown types to the 'unknown' type.

Constructor Detail

SoyTypeRegistry

public SoyTypeRegistry()

Method Detail

getType

@Nullable
public SoyType getType(String typeName)

Look up a type by name. Returns null if there is no such type.

Parameters:

typeName - The fully-qualified name of the type.

Returns:

The type object, or null.

findTypeWithMatchingNamespace

public String findTypeWithMatchingNamespace(String prefix)

Finds a type whose top-level namespace is a specified prefix, or null if there are none.

getOrCreateListType

public ListType getOrCreateListType(SoyType elementType)

Factory function which creates a list type, given an element type. This folds list types with identical element types together, so asking for the same element type twice will return a pointer to the same type object.

Parameters:

elementType - The element type of the list.

Returns:

The list type.

getOrCreateLegacyObjectMapType

public LegacyObjectMapType getOrCreateLegacyObjectMapType(SoyType keyType,
                                                          SoyType valueType)

Factory function which creates a legacy object map type, given a key and value type. This folds map types with identical key/value types together, so asking for the same key/value type twice will return a pointer to the same type object.

Parameters:

keyType - The key type of the map.

valueType - The value type of the map.

Returns:

The map type.

getOrCreateMapType

public MapType getOrCreateMapType(SoyType keyType,
                                  SoyType valueType)

Factory function which creates a map type, given a key and value type. This folds map types with identical key/value types together, so asking for the same key/value type twice will return a pointer to the same type object.

Parameters:

keyType - The key type of the map.

valueType - The value type of the map.

Returns:

The map type.

getOrCreateUnionType

public SoyType getOrCreateUnionType(Collection<SoyType> members)

Factory function which creates a union type, given the member types. This folds identical union types together.

Parameters:

members - The members of the union.

Returns:

The union type.

getOrCreateUnionType

public SoyType getOrCreateUnionType(SoyType... members)

Factory function which creates a union type, given the member types. This folds identical union types together.

Parameters:

members - The members of the union.

Returns:

The union type.

getOrCreateRecordType

public RecordType getOrCreateRecordType(Map<String,SoyType> fields)

Factory function which creates a record type, given a map of fields. This folds map types with identical key/value types together, so asking for the same key/value type twice will return a pointer to the same type object.

Parameters:

fields - The map containing field names and types.

Returns:

The record type.

getOrCreateType

public SoyType getOrCreateType(@Nullable
                               TypeNode node,
                               ErrorReporter errorReporter)

Converts a TypeNode into a SoyType.

If any errors are encountered they are reported to the error reporter.