org.rythmengine.resource

Interface ITemplateResource

All Superinterfaces:

Serializable

All Known Implementing Classes:

ClasspathTemplateResource, FileTemplateResource, StringTemplateResource, TemplateResourceBase, ToStringTemplateResource

public interface ITemplateResource
extends Serializable

Implement a template resource which can be load from some where. For example, a file in a file system or an input stream from the network, or even from the database

Method Summary

Modifier and Type	Method and Description
String	asTemplateContent() Return template content as a string.
ICodeType	codeType(RythmEngine engine) Return code type suggested by this resource, e.g.
Throwable	getError()
Object	getKey() The unique identifier used to fetch this resource by a resource loader
ITemplateResourceLoader	getLoader() Return the loader that loaded this resource
String	getSuggestedClassName() Propose a name of generated java class for this resource
boolean	isValid() Whether this resource is a valid resource
boolean	refresh() Refresh resource if necessary
void	setError(Throwable error)

Method Detail

getKey

Object getKey()

The unique identifier used to fetch this resource by a resource loader

Returns:

the key of the resource

getSuggestedClassName

String getSuggestedClassName()

Propose a name of generated java class for this resource

Returns:

suggested class name

asTemplateContent

String asTemplateContent()

Return template content as a string. Call refresh() first to check if the resource has been modified

Returns:

resource content

refresh

boolean refresh()

Refresh resource if necessary

Returns:

true if resource is modified false otherwise

isValid

boolean isValid()

Whether this resource is a valid resource

Returns:

true if it's a valid resource

codeType

ICodeType codeType(RythmEngine engine)

Return code type suggested by this resource, e.g. html or js etc

Returns:

code type suggested

getLoader

ITemplateResourceLoader getLoader()

Return the loader that loaded this resource

Returns:

the template resource loader that loaded this resource

getError

Throwable getError()

Returns:

the error if there was one

setError

void setError(Throwable error)

Parameters:

error - the error to set