com.google.template.soy.base.internal

Interface SoyFileSupplier

All Known Implementing Classes:

AbstractSoyFileSupplier, StableSoyFileSupplier, VolatileSoyFileSupplier

public interface SoyFileSupplier

Record for one input Soy file.

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

TODO(lukes): This should either be a subtype of CharSource or hold a CharSource

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SoyFileSupplier.Factory Container for factory methods for SoyFileSuppliers.
static interface	SoyFileSupplier.Version An opaque identifier that can be compared for equality with other versions from the same resource.

Method Summary

Modifier and Type	Method and Description
com.google.common.io.CharSource	asCharSource() View this supplier as a CharSource.
String	getFilePath() Returns the path to the Soy file, used for as a unique map/set key and for messages.
SoyFileKind	getSoyFileKind() Returns the kind of this input Soy file.
SoyFileSupplier.Version	getVersion() Returns the version of the Soy file read.
boolean	hasChangedSince(SoyFileSupplier.Version version) True if the underlying resource has changed since the given version.
Reader	open() Returns a Reader for the Soy file content.

Method Detail

asCharSource

com.google.common.io.CharSource asCharSource()

View this supplier as a CharSource.

open

Reader open()
     throws IOException

Returns a Reader for the Soy file content.

Throws:

IOException - If there is an error opening the input.

hasChangedSince

boolean hasChangedSince(SoyFileSupplier.Version version)

True if the underlying resource has changed since the given version.

getSoyFileKind

SoyFileKind getSoyFileKind()

Returns the kind of this input Soy file.

getFilePath

String getFilePath()

Returns the path to the Soy file, used for as a unique map/set key and for messages.

getVersion

SoyFileSupplier.Version getVersion()

Returns the version of the Soy file read.