org.xwiki.gwt.wysiwyg.client.plugin.macro

Class MacroCall

java.lang.Object

org.xwiki.gwt.wysiwyg.client.plugin.macro.MacroCall

public class MacroCall
extends Object

Stores information about a macro call.

Version:

$Id: 34ed4eb9cd859f9bb7e369b76874c268f7a3454a $

Constructor Summary

Constructors

Constructor and Description
MacroCall() Creates a new empty macro call.
MacroCall(String startMacroComment) Creates a new macro call from a start comment node's value.

Method Summary

Modifier and Type	Method and Description
String	getArgument(String name)
String	getContent()
String	getName()
String	removeArgument(String name) Removes the specified argument from this macro call.
String	setArgument(String name, String value) Sets the value of the specified argument.
void	setContent(String content) Sets the content of the macro.
void	setName(String name) Sets the name of the macro to be called.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MacroCall

public MacroCall()

Creates a new empty macro call.

MacroCall

public MacroCall(String startMacroComment)

Creates a new macro call from a start comment node's value.

Parameters:

startMacroComment - the value of a start macro comment

Method Detail

getName

public String getName()

Returns:

the name of the macro

setName

public void setName(String name)

Sets the name of the macro to be called.

Parameters:

name - a macro name

getArgument

public String getArgument(String name)

Parameters:

name - the name of an argument

Returns:

the value of the given argument

setArgument

public String setArgument(String name,
                          String value)

Sets the value of the specified argument.

Parameters:

name - the name of the argument

value - the value of the argument

Returns:

the previous value of the given argument, or null if this argument was not specified

removeArgument

public String removeArgument(String name)

Removes the specified argument from this macro call.

Parameters:

name - the name of a macro parameter

Returns:

the value previously associated with the specified argument

getContent

public String getContent()

Returns:

content

setContent

public void setContent(String content)

Sets the content of the macro.

Parameters:

content - the content of the macro

toString

public String toString()

Overrides:

toString in class Object