com.google.template.soy.base.internal

Class VolatileSoyFileSupplier

java.lang.Object

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

All Implemented Interfaces:

SoyFileSupplier

public final class VolatileSoyFileSupplier
extends Object

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

Modifier and Type	Field and Description
protected String	filePath Returns the file path (used for messages only).
protected SoyFileKind	soyFileKind Whether this input file is only included because it's a dependency.

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
boolean	equals(Object other) Tests equality based on the file path.
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.
int	hashCode() Hashes based on the file path.
Reader	open() Returns a Reader for the Soy file content.

Methods inherited from class java.lang.Object

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

Field Detail

soyFileKind

protected final SoyFileKind soyFileKind

Whether this input file is only included because it's a dependency.

filePath

protected final String filePath

Returns the file path (used for messages only).

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.

getSoyFileKind

public SoyFileKind getSoyFileKind()

Description copied from interface: SoyFileSupplier

Returns the kind of this input Soy file.

Specified by:

getSoyFileKind in interface SoyFileSupplier

getFilePath

public String getFilePath()

Description copied from interface: SoyFileSupplier

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

Specified by:

getFilePath in interface SoyFileSupplier

equals

public boolean equals(Object other)

Tests equality based on the file path. This allows deduping of suppliers that refer to the same underlying file.

NOTE: This will consider different file supplier implementations and different file kinds as distinct since they behave differently. The caller may want to explicitly check for filename collisions afterwards in case the same file is used with different supplier subclasses or file kinds.

Overrides:

equals in class Object

hashCode

public int hashCode()

Hashes based on the file path.

Overrides:

hashCode in class Object