Package com.atlassian.confluence.xhtml.api

Enum Class MacroDefinitionMarshallingStrategy

java.lang.Object

java.lang.Enum<MacroDefinitionMarshallingStrategy>

com.atlassian.confluence.xhtml.api.MacroDefinitionMarshallingStrategy

All Implemented Interfaces:

Serializable, Comparable<MacroDefinitionMarshallingStrategy>, Constable

public enum MacroDefinitionMarshallingStrategy
extends Enum<MacroDefinitionMarshallingStrategy>

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 Constants

Enum Constant	Description
DISCARD_MACRO	Discard the macro now that we're done with it.
MARSHALL_MACRO	Marshall the macro, to allow its use later on.

Method Summary

Modifier and Type	Method	Description
abstract Streamable	marshal(MacroDefinition macroDefinition, ConversionContext conversionContext, Marshaller<MacroDefinition> macroDefinitionMarshaller)	Convert the MacroDefinition to a string.
static MacroDefinitionMarshallingStrategy	valueOf(String name)	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.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DISCARD_MACRO

public static final MacroDefinitionMarshallingStrategy DISCARD_MACRO

Discard the macro now that we're done with it.

MARSHALL_MACRO

public static final MacroDefinitionMarshallingStrategy MARSHALL_MACRO

Marshall the macro, to allow its use later on.

Method Details

values

public static MacroDefinitionMarshallingStrategy[] 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

public static MacroDefinitionMarshallingStrategy valueOf(String name)

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 name

NullPointerException - 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 convert

conversionContext - the context for converting the macro

macroDefinitionMarshaller - a marshaller capable of converting the macro

Returns:

the converted macro string

Throws:

XhtmlException