org.xwiki.template

Interface TemplateContent

@Unstable
public interface TemplateContent

The content of a template.

Since:

7.0M1

Version:

$Id: 012a54fffc6cf54d51cfdfe5aba18f8550765f9b $

Method Summary

Methods

Modifier and Type	Method and Description
DocumentReference	getAuthorReference()
String	getContent()
<T> T	getProperty(String name, T def) Return custom property with the provided name and converted (if needed) to the passed default value type.
<T> T	getProperty(String name, Type type) Return custom property with the provided name and converted (if needed) to the passed type.
org.xwiki.rendering.syntax.Syntax	getRawSyntax()
org.xwiki.rendering.syntax.Syntax	getSourceSyntax()

Method Detail

getContent

String getContent()

Returns:

the source of the template

getSourceSyntax

org.xwiki.rendering.syntax.Syntax getSourceSyntax()

Returns:

the syntax of the content

getRawSyntax

org.xwiki.rendering.syntax.Syntax getRawSyntax()

Returns:

the syntax so set in the RawBlock, note taken into account if a source syntax is provided

getProperty

<T> T getProperty(String name,
                Type type)

Return custom property with the provided name and converted (if needed) to the passed type.

Type Parameters:

T - the type of the value to return

Parameters:

name - the name of the property

type - the type of the property

Returns:

the property value in the provided type or null if none could be found

getProperty

<T> T getProperty(String name,
                T def)

Return custom property with the provided name and converted (if needed) to the passed default value type. If the property does not exist the default value is returned.

Type Parameters:

T - the type of the value to return

Parameters:

name - the name of the property

def - the default value

Returns:

the property value in the provided default value type or the provided default value if none could be found

getAuthorReference

DocumentReference getAuthorReference()

Returns:

the author of the template