org.xwiki.rendering.syntax

Class Syntax

java.lang.Object

org.xwiki.rendering.syntax.Syntax

All Implemented Interfaces:

Comparable<Syntax>

public class Syntax
extends Object
implements Comparable<Syntax>

Represents a wiki syntax that the user can use to enter wiki content. A syntax is made of two parts: a type (eg XWiki, Confluence, MediaWiki, etc) and a version (1.0, 2.0, etc). For example the XWiki 1.0 syntax, the XWiki 2.0 syntax, the Confluence 1.0 syntax, etc.

Since:

2.0RC1

Version:

$Id: b0a43917525212ae3c5f79e34fc74f047ec7db2c $

Field Summary

Fields

Modifier and Type	Field and Description
static Syntax	ANNOTATED_HTML_5_0 This is HTML5 with annotations (comments) in order to allow round tripping between for example the WYSIWYG editor and wiki syntax.
static Syntax	ANNOTATED_XHTML_1_0 This is HTML with annotations (comments) in order to allow round tripping between for example the WYSIWYG editor and wiki syntax.
static Syntax	APT_1_0
static Syntax	CONFLUENCE_1_0 Confluence wiki syntax.
static Syntax	CONFLUENCEXHTML_1_0 Confluence XHTML based syntax.
static Syntax	CREOLE_1_0
static Syntax	DOCBOOK_4_4
static Syntax	EVENT_1_0
static Syntax	HTML_4_01
static Syntax	HTML_5_0 HTML5 syntax.
static Syntax	JSPWIKI_1_0
static Syntax	MARKDOWN_1_0
static Syntax	MARKDOWN_1_1
static Syntax	MEDIAWIKI_1_0
static Syntax	PLAIN_1_0
static Syntax	TEX_1_0
static Syntax	TWIKI_1_0
static Syntax	XDOMXML_1_0
static Syntax	XDOMXML_CURRENT
static Syntax	XHTML_1_0
static Syntax	XWIKI_1_0 Deprecated. since 5.0
static Syntax	XWIKI_2_0
static Syntax	XWIKI_2_1

Constructor Summary

Constructors

Constructor and Description
Syntax(SyntaxType type, String version)
Syntax(SyntaxType type, String version, String qualifier)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Syntax syntax)
boolean	equals(Object object)
String	getQualifier()
SyntaxType	getType()
String	getVersion()
int	hashCode()
String	toIdString()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

HTML_5_0

public static final Syntax HTML_5_0

HTML5 syntax.

Since:

6.4M3

XHTML_1_0

public static final Syntax XHTML_1_0

HTML_4_01

public static final Syntax HTML_4_01

XWIKI_1_0

@Deprecated
public static final Syntax XWIKI_1_0

Deprecated. since 5.0

XWIKI_2_0

public static final Syntax XWIKI_2_0

XWIKI_2_1

public static final Syntax XWIKI_2_1

PLAIN_1_0

public static final Syntax PLAIN_1_0

EVENT_1_0

public static final Syntax EVENT_1_0

TEX_1_0

public static final Syntax TEX_1_0

CREOLE_1_0

public static final Syntax CREOLE_1_0

JSPWIKI_1_0

public static final Syntax JSPWIKI_1_0

MEDIAWIKI_1_0

public static final Syntax MEDIAWIKI_1_0

TWIKI_1_0

public static final Syntax TWIKI_1_0

DOCBOOK_4_4

public static final Syntax DOCBOOK_4_4

CONFLUENCE_1_0

public static final Syntax CONFLUENCE_1_0

Confluence wiki syntax.

CONFLUENCEXHTML_1_0

public static final Syntax CONFLUENCEXHTML_1_0

Confluence XHTML based syntax.

Since:

5.3M1

XDOMXML_CURRENT

public static final Syntax XDOMXML_CURRENT

Since:

3.3M1

XDOMXML_1_0

public static final Syntax XDOMXML_1_0

Since:

3.3M1

MARKDOWN_1_0

public static final Syntax MARKDOWN_1_0

Since:

3.4M1

MARKDOWN_1_1

public static final Syntax MARKDOWN_1_1

Since:

5.2M1

APT_1_0

public static final Syntax APT_1_0

Since:

4.3M1

ANNOTATED_XHTML_1_0

public static final Syntax ANNOTATED_XHTML_1_0

This is HTML with annotations (comments) in order to allow round tripping between for example the WYSIWYG editor and wiki syntax.

ANNOTATED_HTML_5_0

public static final Syntax ANNOTATED_HTML_5_0

This is HTML5 with annotations (comments) in order to allow round tripping between for example the WYSIWYG editor and wiki syntax.

Constructor Detail

Syntax

public Syntax(SyntaxType type,
              String version)

Syntax

public Syntax(SyntaxType type,
              String version,
              String qualifier)

Method Detail

getType

public SyntaxType getType()

getVersion

public String getVersion()

getQualifier

public String getQualifier()

toIdString

public String toIdString()

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

compareTo

public int compareTo(Syntax syntax)

Specified by:

compareTo in interface Comparable<Syntax>