|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.restlet.representation.Variant
org.restlet.representation.RepresentationInfo
org.restlet.representation.Representation
org.restlet.representation.CharacterRepresentation
org.restlet.representation.WriterRepresentation
org.restlet.ext.freemarker.TemplateRepresentation
public class TemplateRepresentation
FreeMarker template representation. Useful for dynamic string-based representations.
Field Summary |
---|
Fields inherited from class org.restlet.representation.Representation |
---|
UNKNOWN_SIZE |
Constructor Summary | |
---|---|
TemplateRepresentation(Representation templateRepresentation,
Configuration config,
MediaType mediaType)
Constructor. |
|
TemplateRepresentation(Representation templateRepresentation,
Configuration config,
Object dataModel,
MediaType mediaType)
Constructor. |
|
TemplateRepresentation(Representation templateRepresentation,
MediaType mediaType)
Constructor. |
|
TemplateRepresentation(Representation templateRepresentation,
Object dataModel,
MediaType mediaType)
Constructor. |
|
TemplateRepresentation(String templateName,
Configuration config,
MediaType mediaType)
Constructor. |
|
TemplateRepresentation(String templateName,
Configuration config,
Object dataModel,
MediaType mediaType)
Constructor. |
|
TemplateRepresentation(Template template,
MediaType mediaType)
Constructor. |
|
TemplateRepresentation(Template template,
Object dataModel,
MediaType mediaType)
Constructor. |
Method Summary | |
---|---|
Object |
getDataModel()
Returns the template's data model. |
Template |
getTemplate()
Returns the FreeMarker template. |
static Template |
getTemplate(Configuration config,
Representation templateRepresentation)
Returns a FreeMarker template from a representation and a configuration. |
static Template |
getTemplate(Configuration config,
String templateName)
Returns a FreeMarker template from its name and a configuration. |
Object |
setDataModel(Object dataModel)
Sets the template's data model. |
Object |
setDataModel(Request request,
Response response)
Sets the template's data model from a request/response pair. |
Object |
setDataModel(Resolver<Object> resolver)
Sets the template's data model from a resolver. |
void |
setTemplate(Template template)
Sets the FreeMarker template. |
void |
write(Writer writer)
Writes the datum as a stream of characters. |
Methods inherited from class org.restlet.representation.WriterRepresentation |
---|
getReader |
Methods inherited from class org.restlet.representation.CharacterRepresentation |
---|
getChannel, getStream, write, write |
Methods inherited from class org.restlet.representation.Representation |
---|
append, exhaust, getAvailableSize, getDigest, getDisposition, getExpirationDate, getRange, getRegistration, getSize, getText, hasKnownSize, isAvailable, isEmpty, isSelectable, isTransient, release, setAvailable, setDigest, setDisposition, setExpirationDate, setListener, setRange, setSize, setTransient |
Methods inherited from class org.restlet.representation.RepresentationInfo |
---|
getModificationDate, getTag, setModificationDate, setTag |
Methods inherited from class org.restlet.representation.Variant |
---|
createClientInfo, equals, getCharacterSet, getEncodings, getLanguages, getLocationRef, getMediaType, includes, isCompatible, setCharacterSet, setEncodings, setLanguages, setLocationRef, setLocationRef, setMediaType, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public TemplateRepresentation(Representation templateRepresentation, Configuration config, MediaType mediaType)
templateRepresentation
- The FreeMarker template provided via a representation.config
- The FreeMarker configuration.mediaType
- The representation's media type.public TemplateRepresentation(Representation templateRepresentation, Configuration config, Object dataModel, MediaType mediaType)
templateRepresentation
- The FreeMarker template provided via a representation.config
- The FreeMarker configuration.dataModel
- The template's data model.mediaType
- The representation's media type.public TemplateRepresentation(Representation templateRepresentation, MediaType mediaType)
templateRepresentation
- The FreeMarker template provided via a representation.mediaType
- The representation's media type.public TemplateRepresentation(Representation templateRepresentation, Object dataModel, MediaType mediaType)
templateRepresentation
- The FreeMarker template provided via a representation.dataModel
- The template's data model.mediaType
- The representation's media type.public TemplateRepresentation(String templateName, Configuration config, MediaType mediaType)
templateName
- The FreeMarker template's name. The full path is resolved by
the configuration.config
- The FreeMarker configuration.mediaType
- The representation's media type.public TemplateRepresentation(String templateName, Configuration config, Object dataModel, MediaType mediaType)
templateName
- The FreeMarker template's name. The full path is resolved by
the configuration.config
- The FreeMarker configuration.dataModel
- The template's data model.mediaType
- The representation's media type.public TemplateRepresentation(Template template, MediaType mediaType)
template
- The FreeMarker template.mediaType
- The representation's media type.public TemplateRepresentation(Template template, Object dataModel, MediaType mediaType)
template
- The FreeMarker template.dataModel
- The template's data model.mediaType
- The representation's media type.Method Detail |
---|
public static Template getTemplate(Configuration config, Representation templateRepresentation)
config
- The FreeMarker configuration.templateRepresentation
- The template representation.
public static Template getTemplate(Configuration config, String templateName)
config
- The FreeMarker configuration.templateName
- The template name.
public Object getDataModel()
public Template getTemplate()
public Object setDataModel(Object dataModel)
dataModel
- The template's data model.
public Object setDataModel(Request request, Response response)
request
- The request where data are located.response
- The response where data are located.
Resolver
,
Resolver.createResolver(Request, Response)
public Object setDataModel(Resolver<Object> resolver)
resolver
- The resolver.
public void setTemplate(Template template)
template
- The FreeMarker template.public void write(Writer writer) throws IOException
write
in class Representation
writer
- The writer to use when writing.
IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |