public class

MacroDefinition

extends Object
java.lang.Object
   ↳ com.atlassian.confluence.xhtml.api.MacroDefinition

Class Overview

An object that encapsulates the state for a macro.

Summary

Public Constructors
MacroDefinition()
MacroDefinition(MacroDefinition macroDefinition)
Copy constructor.
MacroDefinition(String name, MacroBody body, String defaultParameterValue, Map<String, String> parameters)
Construct a macro definition.
Public Methods
boolean equals(Object o)
MacroBody getBody()
String getBodyText()
String getDefaultParameterValue()
String getName()
Map<String, String> getParameters()
boolean hasBody()
int hashCode()
boolean isValid()
void setBody(MacroBody body)
void setDefaultParameterValue(String defaultParameterValue)
void setName(String name)
void setParameters(Map<String, String> parameters)
String toString()
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public MacroDefinition ()

public MacroDefinition (MacroDefinition macroDefinition)

Copy constructor.

Parameters
macroDefinition copy the state of this macro definition into this new instance

public MacroDefinition (String name, MacroBody body, String defaultParameterValue, Map<String, String> parameters)

Construct a macro definition.

Parameters
name the name of the macro
body the macro body. Should be set to null if the macro does not have a body. Also see PlainTextMacroBody and RichTextMacroBody.
defaultParameterValue the default macro parameter value. This value is not assigned an actual parameter name.
parameters the macro parameters

Public Methods

public boolean equals (Object o)

public MacroBody getBody ()

public String getBodyText ()

public String getDefaultParameterValue ()

public String getName ()

public Map<String, String> getParameters ()

public boolean hasBody ()

public int hashCode ()

public boolean isValid ()

Returns
  • true if there is at least a name on this MacroDefinition.

public void setBody (MacroBody body)

public void setDefaultParameterValue (String defaultParameterValue)

public void setName (String name)

public void setParameters (Map<String, String> parameters)

public String toString ()