com.google.template.soy.soytree

Class TemplateRegistry

java.lang.Object

com.google.template.soy.soytree.TemplateRegistry

public final class TemplateRegistry
extends Object

A registry or index of all templates in a Soy tree.

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	TemplateRegistry.DelegateTemplateConflictException Exception thrown when there's no unique highest-priority active delegate template at render time.
static class	TemplateRegistry.DelegateTemplateDivision Represents a set of delegate templates with the same key (name and variant) and same priority.

Constructor Summary

Constructors

Constructor and Description
TemplateRegistry(SoyFileSetNode soyTree) Constructor.

Method Summary

Modifier and Type	Method and Description
TemplateBasicNode	getBasicTemplate(String templateName) Retrieves a basic template given the template name.
Map<String,TemplateBasicNode>	getBasicTemplatesMap() Returns a map from basic template name to node.
Set<TemplateRegistry.DelegateTemplateDivision>	getDelTemplateDivisionsForAllVariants(String delTemplateName) Retrieves the set of DelegateTemplateDivisions for all variants of a given a delegate template name.
Set<TemplateDelegateNode.DelTemplateKey>	getDelTemplateKeysForAllVariants(String delTemplateName) Retrieves the set of key (name and variant) strings for all variants of a given delegate template name.
Map<String,Set<TemplateDelegateNode.DelTemplateKey>>	getDelTemplateNameToKeysMap() Returns a map from delegate template name to set of keys.
Map<TemplateDelegateNode.DelTemplateKey,List<TemplateRegistry.DelegateTemplateDivision>>	getDelTemplatesMap() Returns a map from delegate template key (name and variant) to list of DelegateTemplateDivisions, where each list is sorted in descending priority order.
TemplateDelegateNode	selectDelTemplate(TemplateDelegateNode.DelTemplateKey delTemplateKey, Set<String> activeDelPackageNames) Selects a delegate template based on the rendering rules, given the delegate template key (name and variant) and the set of active delegate package names.

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateRegistry

public TemplateRegistry(SoyFileSetNode soyTree)

Constructor.

Parameters:

soyTree - The Soy tree from which to build a template registry.

Method Detail

getBasicTemplatesMap

public Map<String,TemplateBasicNode> getBasicTemplatesMap()

Returns a map from basic template name to node.

getBasicTemplate

public TemplateBasicNode getBasicTemplate(String templateName)

Retrieves a basic template given the template name.

Parameters:

templateName - The basic template name to retrieve.

Returns:

The corresponding basic template, or null if the template name is not defined.

getDelTemplateNameToKeysMap

public Map<String,Set<TemplateDelegateNode.DelTemplateKey>> getDelTemplateNameToKeysMap()

Returns a map from delegate template name to set of keys.

getDelTemplatesMap

public Map<TemplateDelegateNode.DelTemplateKey,List<TemplateRegistry.DelegateTemplateDivision>> getDelTemplatesMap()

Returns a map from delegate template key (name and variant) to list of DelegateTemplateDivisions, where each list is sorted in descending priority order.

getDelTemplateKeysForAllVariants

public Set<TemplateDelegateNode.DelTemplateKey> getDelTemplateKeysForAllVariants(String delTemplateName)

Retrieves the set of key (name and variant) strings for all variants of a given delegate template name.

Parameters:

delTemplateName - The delegate template name to retrieve.

Returns:

The set of keys for all variants.

getDelTemplateDivisionsForAllVariants

public Set<TemplateRegistry.DelegateTemplateDivision> getDelTemplateDivisionsForAllVariants(String delTemplateName)

Retrieves the set of DelegateTemplateDivisions for all variants of a given a delegate template name.

Parameters:

delTemplateName - The delegate template name to retrieve.

Returns:

The set of DelegateTemplateDivisions for all variants.

selectDelTemplate

public TemplateDelegateNode selectDelTemplate(TemplateDelegateNode.DelTemplateKey delTemplateKey,
                                              Set<String> activeDelPackageNames)
                                       throws TemplateRegistry.DelegateTemplateConflictException

Selects a delegate template based on the rendering rules, given the delegate template key (name and variant) and the set of active delegate package names.

Parameters:

delTemplateKey - The delegate template key (name and variant) to select an implementation for.

activeDelPackageNames - The set of active delegate package names.

Returns:

The selected delegate template, or null if there are no active implementations.

Throws:

TemplateRegistry.DelegateTemplateConflictException - If there are two or more active implementations with equal priority (unable to select one over the other).