com.google.template.soy.base.internal

Class VolatileSoyFileSupplier

java.lang.Object

com.google.common.io.CharSource

com.google.template.soy.base.internal.AbstractSoyFileSupplier

com.google.template.soy.base.internal.VolatileSoyFileSupplier

All Implemented Interfaces:

SoyFileSupplier

public final class VolatileSoyFileSupplier
extends AbstractSoyFileSupplier

Record for one input Soy file whose content should be considered prone to change without warning.

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

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.template.soy.base.internal.SoyFileSupplier

SoyFileSupplier.Factory, SoyFileSupplier.Version

Field Summary

Fields inherited from class com.google.template.soy.base.internal.AbstractSoyFileSupplier

filePath, soyFileKind

Constructor Summary

Constructors

Constructor and Description
VolatileSoyFileSupplier(File file, SoyFileKind soyFileKind) Creates a Soy file supplier whose content is backed by the given file which is prone to change without warning.

Method Summary

Modifier and Type	Method and Description
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.

Methods inherited from class com.google.template.soy.base.internal.AbstractSoyFileSupplier

asCharSource, equals, getFilePath, getSoyFileKind, hashCode, openStream

Methods inherited from class com.google.common.io.CharSource

asByteSource, concat, concat, concat, copyTo, copyTo, empty, isEmpty, length, lengthIfKnown, openBufferedStream, read, readFirstLine, readLines, readLines, wrap

Methods inherited from class java.lang.Object

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

Constructor Detail

VolatileSoyFileSupplier

public VolatileSoyFileSupplier(File file,
                               SoyFileKind soyFileKind)

Creates a Soy file supplier whose content is backed by the given file which is prone to change without warning.

Parameters:

file - The underlying file to read.

soyFileKind - The kind of this input Soy file.

Method Detail

hasChangedSince

public boolean hasChangedSince(SoyFileSupplier.Version version)

Description copied from interface: SoyFileSupplier

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

open

public Reader open()
            throws IOException

Description copied from interface: SoyFileSupplier

Returns a Reader for the Soy file content.

Throws:

IOException - If there is an error opening the input.

getVersion

public SoyFileSupplier.Version getVersion()

Description copied from interface: SoyFileSupplier

Returns the version of the Soy file read.