com.atlassian.confluence.xhtml.api
Class MacroDefinition

java.lang.Object
  extended by com.atlassian.confluence.xhtml.api.MacroDefinition

public class MacroDefinition
extends java.lang.Object

An object that encapsulates the state for a macro.


Field Summary
static java.lang.String STORAGE_VERSION_1
           
static java.lang.String STORAGE_VERSION_2
           
 
Constructor Summary
MacroDefinition()
           
MacroDefinition(MacroDefinition macroDefinition)
          Copy constructor.
MacroDefinition(java.lang.String name, MacroBody body, java.util.Map<java.lang.String,java.lang.String> parameters, java.util.Map<java.lang.String,java.lang.Object> typedParameters, java.lang.String storageVersion)
          Construct a macro definition.
MacroDefinition(java.lang.String name, MacroBody body, java.lang.String defaultParameterValue, java.util.Map<java.lang.String,java.lang.String> parameters)
          Deprecated. since 5.2. Call MacroDefinition(String, MacroBody, Map, Map, String) instead and pass parsed parameter values.
 
Method Summary
 boolean equals(java.lang.Object o)
           
 MacroBody getBody()
           
 Streamable getBodyStream()
           
 java.lang.String getBodyText()
           
 java.lang.String getDefaultParameterValue()
          Equivalent to getParameter(java.lang.String) or getTypedParameter(java.lang.String, java.lang.Class) with ""
 java.lang.String getName()
           
 java.lang.String getParameter(java.lang.String name)
           
 java.util.Map<java.lang.String,java.lang.String> getParameters()
           
 java.lang.String getStorageVersion()
           
<T> T
getTypedParameter(java.lang.String name, java.lang.Class<T> type)
           
 java.util.Map<java.lang.String,java.lang.Object> getTypedParameters()
           
 boolean hasBody()
           
 int hashCode()
           
 boolean isValid()
           
 void setBody(MacroBody body)
           
 void setDefaultParameterValue(java.lang.String defaultParameterValue)
           
 void setName(java.lang.String name)
           
 void setParameter(java.lang.String name, java.lang.String value)
           
 void setParameters(java.util.Map<java.lang.String,java.lang.String> parameters)
           
 void setStorageVersion(java.lang.String storageVersion)
           
 void setTypedParameter(java.lang.String name, java.lang.Object value)
           
 void setTypedParameters(java.util.Map<java.lang.String,java.lang.Object> typedParameters)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

STORAGE_VERSION_1

public static final java.lang.String STORAGE_VERSION_1
See Also:
Constant Field Values

STORAGE_VERSION_2

public static final java.lang.String STORAGE_VERSION_2
See Also:
Constant Field Values
Constructor Detail

MacroDefinition

public MacroDefinition()

MacroDefinition

public MacroDefinition(MacroDefinition macroDefinition)
Copy constructor.

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

MacroDefinition

@Deprecated
public MacroDefinition(java.lang.String name,
                                  MacroBody body,
                                  java.lang.String defaultParameterValue,
                                  java.util.Map<java.lang.String,java.lang.String> parameters)
Deprecated. since 5.2. Call MacroDefinition(String, MacroBody, Map, Map, String) instead and pass parsed parameter values.

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

MacroDefinition

public MacroDefinition(java.lang.String name,
                       MacroBody body,
                       java.util.Map<java.lang.String,java.lang.String> parameters,
                       java.util.Map<java.lang.String,java.lang.Object> typedParameters,
                       java.lang.String storageVersion)
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.
parameters - the macro parameters
typedParameters - the macro parameters that are pre-parsed into their associated types
Since:
5.2
Method Detail

getName

public java.lang.String getName()

getDefaultParameterValue

public java.lang.String getDefaultParameterValue()
Equivalent to getParameter(java.lang.String) or getTypedParameter(java.lang.String, java.lang.Class) with ""

Returns:
the value of the default parameter, or null if there isn't one.

getBodyText

public java.lang.String getBodyText()

getBodyStream

public Streamable getBodyStream()

getBody

public MacroBody getBody()

hasBody

public boolean hasBody()

getParameters

public java.util.Map<java.lang.String,java.lang.String> getParameters()

getTypedParameters

public java.util.Map<java.lang.String,java.lang.Object> getTypedParameters()

getParameter

public java.lang.String getParameter(java.lang.String name)

getTypedParameter

public <T> T getTypedParameter(java.lang.String name,
                               java.lang.Class<T> type)

setName

public void setName(java.lang.String name)

setDefaultParameterValue

public void setDefaultParameterValue(java.lang.String defaultParameterValue)

setBody

public void setBody(MacroBody body)

setParameters

public void setParameters(java.util.Map<java.lang.String,java.lang.String> parameters)

setTypedParameters

public void setTypedParameters(java.util.Map<java.lang.String,java.lang.Object> typedParameters)

setParameter

public void setParameter(java.lang.String name,
                         java.lang.String value)

setTypedParameter

public void setTypedParameter(java.lang.String name,
                              java.lang.Object value)

getStorageVersion

public java.lang.String getStorageVersion()

setStorageVersion

public void setStorageVersion(java.lang.String storageVersion)

isValid

public boolean isValid()
Returns:
true if there is at least a name on this MacroDefinition.

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object


Copyright © 2003-2014 Atlassian. All Rights Reserved.