org.xwiki.rendering.syntax

Class SyntaxType

java.lang.Object

org.xwiki.rendering.syntax.SyntaxType

All Implemented Interfaces:

Comparable<SyntaxType>

public class SyntaxType
extends Object
implements Comparable<SyntaxType>

Since:

2.0RC1

Version:

$Id: 9d36e0a247f320ae18806bc05a76bc7c24a0bdac $

Field Summary

Fields

Modifier and Type	Field and Description
static SyntaxType	ANNOTATED_HTML
static SyntaxType	ANNOTATED_XHTML
static SyntaxType	APT
static SyntaxType	CONFLUENCE Confluence wiki syntax.
static SyntaxType	CONFLUENCEXHTML Confluence XHTML based syntax.
static SyntaxType	CREOLE
static SyntaxType	DOCBOOK
static SyntaxType	EVENT
static SyntaxType	HTML
static SyntaxType	JSPWIKI
static SyntaxType	MARKDOWN
static SyntaxType	MEDIAWIKI
static SyntaxType	PLAIN
static SyntaxType	TEX
static SyntaxType	TWIKI
static SyntaxType	XDOMXML
static SyntaxType	XHTML
static SyntaxType	XWIKI

Constructor Summary

Constructors

Constructor and Description
SyntaxType(String id, String name)

Method Summary

Modifier and Type	Method and Description
int	compareTo(SyntaxType syntaxType)
boolean	equals(Object object)
String	getId()
String	getName()
static Map<String,SyntaxType>	getSyntaxTypes()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

XWIKI

public static final SyntaxType XWIKI

CONFLUENCE

public static final SyntaxType CONFLUENCE

Confluence wiki syntax.

CONFLUENCEXHTML

public static final SyntaxType CONFLUENCEXHTML

Confluence XHTML based syntax.

Since:

5.3M1

MEDIAWIKI

public static final SyntaxType MEDIAWIKI

CREOLE

public static final SyntaxType CREOLE

JSPWIKI

public static final SyntaxType JSPWIKI

TWIKI

public static final SyntaxType TWIKI

XHTML

public static final SyntaxType XHTML

ANNOTATED_XHTML

public static final SyntaxType ANNOTATED_XHTML

ANNOTATED_HTML

public static final SyntaxType ANNOTATED_HTML

HTML

public static final SyntaxType HTML

PLAIN

public static final SyntaxType PLAIN

EVENT

public static final SyntaxType EVENT

TEX

public static final SyntaxType TEX

DOCBOOK

public static final SyntaxType DOCBOOK

XDOMXML

public static final SyntaxType XDOMXML

Since:

3.3M1

MARKDOWN

public static final SyntaxType MARKDOWN

Since:

3.4M1

APT

public static final SyntaxType APT

Since:

4.3M1

Constructor Detail

SyntaxType

public SyntaxType(String id,
                  String name)

Parameters:

id - the technical id of the Syntax type (ex "annotatedxhtml")

name - the human readable name of the Syntax type (ex "Annotated XHTML")

Since:

2.0M3

Method Detail

getSyntaxTypes

public static Map<String,SyntaxType> getSyntaxTypes()

Returns:

the well-known Syntax types

getId

public String getId()

Returns:

the technical id of the Syntax type (ex "annotatedxhtml")

Since:

2.0M3

getName

public String getName()

Returns:

the human readable name of the Syntax type (ex "Annotated XHTML")

Since:

2.0M3

toString

public String toString()

Display a human readable name of the Syntax type.

Overrides:

toString in class Object

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

compareTo

public int compareTo(SyntaxType syntaxType)

Specified by:

compareTo in interface Comparable<SyntaxType>