org.xwiki.rendering.wikimodel

Class WikiMacro

java.lang.Object

org.xwiki.rendering.wikimodel.WikiMacro

public class WikiMacro
extends Object

An immutable object which holds information about a macro reference. Macros are unique just by their name. The content and parameters are optional.

There are a few 'built in' macro names:

• toc
• notoc
• forcetoc
• footnotes

Since:

4.0M1

Version:

$Id: 9190c3c883c7380b9b001c8dd49ffe82c41c2c9b $

Field Summary

Fields

Modifier and Type	Field and Description
static String	MACRO_FOOTNOTES
static String	MACRO_FORCETOC
static String	MACRO_NOTOC
static String	MACRO_TOC
static String	UNHANDLED_MACRO

Constructor Summary

Constructors

Constructor and Description
WikiMacro(String name)
WikiMacro(String name, WikiParameters wikiParameters)
WikiMacro(String name, WikiParameters wikiParameters, String content)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getContent()
String	getName()
WikiParameters	getWikiParameters()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

MACRO_TOC

public static final String MACRO_TOC

See Also:

Constant Field Values

MACRO_NOTOC

public static final String MACRO_NOTOC

See Also:

Constant Field Values

MACRO_FORCETOC

public static final String MACRO_FORCETOC

See Also:

Constant Field Values

MACRO_FOOTNOTES

public static final String MACRO_FOOTNOTES

See Also:

Constant Field Values

UNHANDLED_MACRO

public static final String UNHANDLED_MACRO

See Also:

Constant Field Values

Constructor Detail

WikiMacro

public WikiMacro(String name)

Parameters:

name -

WikiMacro

public WikiMacro(String name,
         WikiParameters wikiParameters)

Parameters:

name -

wikiParameters -

WikiMacro

public WikiMacro(String name,
         WikiParameters wikiParameters,
         String content)

Parameters:

name -

wikiParameters -

content -

Method Detail

getName

public String getName()

Returns:

the name

getContent

public String getContent()

Returns:

the content

getWikiParameters

public WikiParameters getWikiParameters()

Returns:

the wikiParameters

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object