com.atlassian.confluence.xhtml.api

Class MacroDefinitionBuilder

java.lang.Object

com.atlassian.confluence.xhtml.api.MacroDefinitionBuilder

public class MacroDefinitionBuilder
extends Object

A builder that will create the a complex MacroDefinition.

Method Summary

Modifier and Type	Method and Description
MacroDefinition	build()
MacroBody	getMacroBody()
com.atlassian.fugue.Option<MacroId>	getMacroId() Deprecated. since 7.0.1
MacroId	getMacroIdentifier()
String	getName()
Map<String,String>	getParameters()
int	getSchemaVersion()
String	getStorageVersion()
Map<String,Object>	getTypedParameters()
void	setDefaultParameterValue(String defaultParameterValue)
MacroDefinitionBuilder	withMacroBody(MacroBody macroBody)
MacroDefinitionBuilder	withMacroId(MacroId macroId)
MacroDefinitionBuilder	withMacroId(com.atlassian.fugue.Option<MacroId> macroId) Deprecated. since 7.0.1. Use withMacroIdentifier(String)
MacroDefinitionBuilder	withMacroId(String macroId)
MacroDefinitionBuilder	withMacroIdentifier(MacroId macroId)
MacroDefinitionBuilder	withMacroIdentifier(String macroId)
MacroDefinitionBuilder	withName(String name)
MacroDefinitionBuilder	withParameter(String key, String value)
MacroDefinitionBuilder	withParameters(Map<String,String> parameters)
MacroDefinitionBuilder	withSchemaVersion(int schemaVersion)
MacroDefinitionBuilder	withStorageVersion(String storageVersion)
MacroDefinitionBuilder	withTypedParameter(String key, Object value)
MacroDefinitionBuilder	withTypedParameters(Map<String,Object> typedParameters)

Methods inherited from class java.lang.Object

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

Method Detail

withName

public MacroDefinitionBuilder withName(String name)

withMacroBody

public MacroDefinitionBuilder withMacroBody(MacroBody macroBody)

withParameters

public MacroDefinitionBuilder withParameters(Map<String,String> parameters)

withParameter

public MacroDefinitionBuilder withParameter(String key,
                                            String value)

withTypedParameters

public MacroDefinitionBuilder withTypedParameters(Map<String,Object> typedParameters)

withTypedParameter

public MacroDefinitionBuilder withTypedParameter(String key,
                                                 Object value)

withStorageVersion

public MacroDefinitionBuilder withStorageVersion(String storageVersion)

withMacroId

@Deprecated
public MacroDefinitionBuilder withMacroId(com.atlassian.fugue.Option<MacroId> macroId)

Deprecated. since 7.0.1. Use withMacroIdentifier(String)

withMacroId

public MacroDefinitionBuilder withMacroId(MacroId macroId)

withMacroId

public MacroDefinitionBuilder withMacroId(String macroId)

withMacroIdentifier

public MacroDefinitionBuilder withMacroIdentifier(MacroId macroId)

Since:

7.0.1

withMacroIdentifier

public MacroDefinitionBuilder withMacroIdentifier(String macroId)

Since:

7.0.1

withSchemaVersion

public MacroDefinitionBuilder withSchemaVersion(int schemaVersion)

getName

public String getName()

getSchemaVersion

public int getSchemaVersion()

getMacroBody

public MacroBody getMacroBody()

getParameters

public Map<String,String> getParameters()

getTypedParameters

public Map<String,Object> getTypedParameters()

getStorageVersion

public String getStorageVersion()

getMacroId

@Deprecated
public com.atlassian.fugue.Option<MacroId> getMacroId()

Deprecated. since 7.0.1

getMacroIdentifier

public MacroId getMacroIdentifier()

Since:

7.0.1

build

public MacroDefinition build()

setDefaultParameterValue

public void setDefaultParameterValue(String defaultParameterValue)