AbstractSoyFileSupplier (Closure Templates)

java.lang.Object
- com.google.template.soy.base.internal.AbstractSoyFileSupplier

All Implemented Interfaces:

SoyFileSupplier

Direct Known Subclasses:

StableSoyFileSupplier, VolatileSoyFileSupplier
```
public abstract class AbstractSoyFileSupplier
extends Object
implements SoyFileSupplier
```
Abstract base implementation of SoyFileSupplier.
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

AbstractSoyFileSupplier(SoyFileKind soyFileKind, String filePath)

Constructors
Constructor and Description
`AbstractSoyFileSupplier(SoyFileKind soyFileKind, String filePath)`

Method Summary

Methods
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.
`int`	`hashCode()` Hashes based on the file path.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.google.template.soy.base.internal.SoyFileSupplier
getVersion, hasChangedSince, open

- 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
  - AbstractSoyFileSupplier
```
public AbstractSoyFileSupplier(SoyFileKind soyFileKind,
                       String filePath)
```
    Parameters:
    soyFileKind - The kind of this input Soy file.
    filePath - The path to the Soy file, used for as a unique map/set key and for messages.
- Method Detail
  - 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

Class AbstractSoyFileSupplier

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.template.soy.base.internal.SoyFileSupplier

Field Detail

soyFileKind

filePath

Constructor Detail

AbstractSoyFileSupplier

Method Detail

getSoyFileKind

getFilePath

equals

hashCode