Enum Class MacroDefinitionMarshallingStrategy
java.lang.Object
java.lang.Enum<MacroDefinitionMarshallingStrategy>
com.atlassian.confluence.xhtml.api.MacroDefinitionMarshallingStrategy
- All Implemented Interfaces:
Serializable
,Comparable<MacroDefinitionMarshallingStrategy>
,Constable
Provides strategies for marshalling MacroDefinitions.
- Since:
- 5.0
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionDiscard the macro now that we're done with it.Marshall the macro, to allow its use later on. -
Method Summary
Modifier and TypeMethodDescriptionabstract Streamable
marshal
(MacroDefinition macroDefinition, ConversionContext conversionContext, Marshaller<MacroDefinition> macroDefinitionMarshaller) Convert the MacroDefinition to a string.Returns the enum constant of this class with the specified name.static MacroDefinitionMarshallingStrategy[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
DISCARD_MACRO
Discard the macro now that we're done with it. -
MARSHALL_MACRO
Marshall the macro, to allow its use later on.
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-
marshal
public abstract Streamable marshal(MacroDefinition macroDefinition, ConversionContext conversionContext, Marshaller<MacroDefinition> macroDefinitionMarshaller) throws XhtmlException Convert the MacroDefinition to a string.- Parameters:
macroDefinition
- the macro to convertconversionContext
- the context for converting the macromacroDefinitionMarshaller
- a marshaller capable of converting the macro- Returns:
- the converted macro string
- Throws:
XhtmlException
-