com.google.template.soy.shared

Class SoyAstCache

java.lang.Object

com.google.template.soy.shared.SoyAstCache

public final class SoyAstCache
extends Object

Cache for the soy tree respecting file versions.

This allows for file-granularity caching of the parsed tree, to avoid parsing the same file over and over if the contents have not changed. This helps the development experience when there are a large number of files, most of which aren't changing during the edit/reflect loop. This does not help in a production startup-compilation setup; instead, this will just use more memory.

Please treat the internals as Soy superpackage-private.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoyAstCache.VersionedFile A SoyFileNode with an associated SoyFileSupplier.Version.

Constructor Summary

Constructors

Constructor and Description
SoyAstCache()

Method Summary

Modifier and Type	Method and Description
SoyAstCache.VersionedFile	get(String fileName, SoyFileSupplier.Version version) Retrieves a cached version of this file supplier AST, if any.
IdGenerator	getNodeIdGenerator() Returns an ID generator that must be used for all files in this cache.
void	put(String fileName, SoyAstCache.VersionedFile versionedFile) Stores a cached version of the AST.

Methods inherited from class java.lang.Object

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

Constructor Detail

SoyAstCache

@Inject
public SoyAstCache()

Method Detail

put

public void put(String fileName,
                SoyAstCache.VersionedFile versionedFile)

Stores a cached version of the AST.

Please treat this as superpackage-private for Soy internals.

Parameters:

fileName - The name of the file.

versionedFile - The compiled AST at the particular version. The node is defensively copied; the caller is free to modify it.

get

public SoyAstCache.VersionedFile get(String fileName,
                                     SoyFileSupplier.Version version)

Retrieves a cached version of this file supplier AST, if any.

Please treat this as superpackage-private for Soy internals.

Parameters:

fileName - The name of the file

version - The current file version.

Returns:

A fresh copy of the tree that may be modified by the caller, or null if no entry was found in the cache.

getNodeIdGenerator

public IdGenerator getNodeIdGenerator()

Returns an ID generator that must be used for all files in this cache.

If this ID generator is not used, nodes in the cache will have conflicting ID's. It is important to use a manual synchronized block over this cache while using the ID generator since the ID generator is not guaranteed to be thread-safe!

Please treat this as superpackage-private for Soy internals.