org.thymeleaf.templateresource

Class FileTemplateResource

Object

org.thymeleaf.templateresource.FileTemplateResource

All Implemented Interfaces:

Serializable, ITemplateResource

public final class FileTemplateResource
extends Object
implements ITemplateResource, Serializable

Implementation of ITemplateResource representing a file in the file system.

Objects of this class are usually created by FileTemplateResolver.

Since:

3.0.0

Author:

Daniel Fernández

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FileTemplateResource(File file, String characterEncoding)
FileTemplateResource(String path, String characterEncoding)

Method Summary

Modifier and Type	Method and Description
boolean	exists() Determines whether the resource represented by this object really exists or not.
String	getBaseName() Returns the base name of a resource.
String	getDescription() Returns a String describing the resource.
Reader	reader() Returns a Reader that can be used for consuming the template contents.
ITemplateResource	relative(String relativeLocation) Creates another ITemplateResource, usually of the same implementation class, for a resource living in a location relative to the current object's.

Methods inherited from class Object

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

Constructor Detail

FileTemplateResource

public FileTemplateResource(String path,
                            String characterEncoding)

FileTemplateResource

public FileTemplateResource(File file,
                            String characterEncoding)

Method Detail

getDescription

public String getDescription()

Description copied from interface: ITemplateResource

Returns a String describing the resource.

Note this should not be taken for a valid resource name, as depending on the implementation it could be too verbose/descriptive or not unique enough to be used for identification purposes.

Specified by:

getDescription in interface ITemplateResource

Returns:

the resource description. Should never return null.

getBaseName

public String getBaseName()

Description copied from interface: ITemplateResource

Returns the base name of a resource.

The base name is aimed at creating derivative names from the name of the resource, usually from the deepest level of the resource path.

For example, a file resource located at /home/user/template/main.html should return main as its base name, so that names like main.properties, main.th.xml or similar can be derived, and afterwards resolved using ITemplateResource.relative(String).

Specified by:

getBaseName in interface ITemplateResource

Returns:

the base name, or null if it cannot be computed for the specific type of resource.

reader

public Reader reader()
              throws IOException

Description copied from interface: ITemplateResource

Returns a Reader that can be used for consuming the template contents.

Most implementations of this interface will require specifying a character encoding during construction, so that this readers are correctly able to decode their underlying input streams.

Note this readers should be closed after being fully consumed, just like any other resources.

Specified by:

reader in interface ITemplateResource

Returns:

a Reader on the template contents. Should never return null.

Throws:

IOException - if an input/output exception happens or if the resource does not exist (e.g. FileNotFoundException).

relative

public ITemplateResource relative(String relativeLocation)
                           throws IOException

Description copied from interface: ITemplateResource

Creates another ITemplateResource, usually of the same implementation class, for a resource living in a location relative to the current object's.

Note some ITemplateResource implementations might not support this feature.

Specified by:

relative in interface ITemplateResource

Parameters:

relativeLocation - the location of the resource we want to obtain, relative to the current one. Required.

Returns:

the relative resource. Should never return null.

Throws:

IOException - if an input/output exception happens or if the resource does not exist (e.g. FileNotFoundException).

exists

public boolean exists()

Description copied from interface: ITemplateResource

Determines whether the resource represented by this object really exists or not.

Note that, depending on the implementation, this might mean actually access the resource, and such operation could have a cost in performance in some scenarios (e.g. a resource representing a remote URL).

This mechanism will be used by Template Resolvers extending from AbstractTemplateResolver for checking real resource existence if the AbstractTemplateResolver.setCheckExistence(boolean) flag is set to true.

Specified by:

exists in interface ITemplateResource

Returns:

true if the resource exists, false if not.