|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.confluence.macro.browser.beans.MacroParameter
public class MacroParameter
Represents parameter metadata for a macro.
Constructor Summary | |
---|---|
MacroParameter(java.lang.String pluginKey,
java.lang.String macroName,
java.lang.String name,
MacroParameterType type,
boolean required,
boolean multiple,
java.lang.String defaultValue,
boolean hidden)
|
|
MacroParameter(java.lang.String pluginKey,
java.lang.String macroName,
java.lang.String name,
MacroParameterType type,
boolean required,
boolean multiple,
java.lang.String defaultValue,
boolean hidden,
java.lang.String documentationUrl)
|
Method Summary | |
---|---|
void |
addAlias(java.lang.String alias)
Adds an alias name for the parameter. |
void |
addEnumValue(java.lang.String value)
Adds an enum value to the paramter. |
void |
addOption(java.lang.String key,
java.lang.String value)
Adds an option key/value pair for this parameter. |
java.util.Set<java.lang.String> |
getAliases()
|
java.lang.String |
getDefaultValue()
Returns the default value of the parameter. |
Message |
getDescription()
|
Message |
getDisplayName()
|
java.util.List<java.lang.String> |
getEnumValues()
Returns a list of enum values. |
java.lang.String |
getName()
|
java.util.Properties |
getOptions()
|
MacroParameterType |
getType()
|
boolean |
isHidden()
Whether or not to hide the macro parameter from display in the macro browser. |
boolean |
isMultiple()
|
boolean |
isRequired()
|
void |
setDescription(java.lang.String description)
|
void |
setDisplayName(java.lang.String displayName)
|
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public MacroParameter(java.lang.String pluginKey, java.lang.String macroName, java.lang.String name, MacroParameterType type, boolean required, boolean multiple, java.lang.String defaultValue, boolean hidden)
public MacroParameter(java.lang.String pluginKey, java.lang.String macroName, java.lang.String name, MacroParameterType type, boolean required, boolean multiple, java.lang.String defaultValue, boolean hidden, java.lang.String documentationUrl)
Method Detail |
---|
public boolean isHidden()
public void addAlias(java.lang.String alias)
public void addEnumValue(java.lang.String value)
public void addOption(java.lang.String key, java.lang.String value)
public java.lang.String getName()
public MacroParameterType getType()
public java.lang.String getDefaultValue()
MacroParameterType.BOOLEAN
type parameters; in which case "false" is returned.
public boolean isRequired()
public boolean isMultiple()
public java.util.Set<java.lang.String> getAliases()
public java.util.List<java.lang.String> getEnumValues()
public java.util.Properties getOptions()
public Message getDisplayName()
public Message getDescription()
public java.lang.String toString()
toString
in class java.lang.Object
public void setDisplayName(java.lang.String displayName)
public void setDescription(java.lang.String description)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |