com.atlassian.confluence.macro.query.params
Class MultiValueParameter

java.lang.Object
  com.atlassian.confluence.macro.params.BaseParameter<java.util.Set<java.lang.String>>
      com.atlassian.confluence.macro.query.params.MultiValueParameter

All Implemented Interfaces:

Parameter<java.util.Set<java.lang.String>>

Direct Known Subclasses:

AuthorParameter

public class MultiValueParameter
extends BaseParameter<java.util.Set<java.lang.String>>

Represents a macro parameter that can accept a multiple delimited values.

Field Summary

Fields inherited from class com.atlassian.confluence.macro.params.BaseParameter

shouldValidate

Constructor Summary

MultiValueParameter(java.util.List<java.lang.String> names, java.lang.String defaultValue, java.lang.String delimiter)

MultiValueParameter(java.lang.String[] names, java.lang.String defaultValue, java.lang.String delimiter)

MultiValueParameter(java.lang.String name, java.lang.String defaultValue, java.lang.String delimiter)

Method Summary

protected java.util.Set<java.lang.String>

findObject(java.lang.String paramValue, MacroExecutionContext ctx) Responsible for converting a macro parameter string value to its proper object representation (say "1" to new Integer(1))

Methods inherited from class com.atlassian.confluence.macro.params.BaseParameter

addParameterAlias, findValue, getDefaultValue, getParameter, getParameterValue, setDefaultValue, setParameterNames, setValidate

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiValueParameter

public MultiValueParameter(java.lang.String name,
                           java.lang.String defaultValue,
                           java.lang.String delimiter)

MultiValueParameter

public MultiValueParameter(java.lang.String[] names,
                           java.lang.String defaultValue,
                           java.lang.String delimiter)

MultiValueParameter

public MultiValueParameter(java.util.List<java.lang.String> names,
                           java.lang.String defaultValue,
                           java.lang.String delimiter)

Method Detail

findObject

protected java.util.Set<java.lang.String> findObject(java.lang.String paramValue,
                                                     MacroExecutionContext ctx)
                                              throws ParameterException

Description copied from class: BaseParameter

Responsible for converting a macro parameter string value to its proper object representation (say "1" to new Integer(1))

Specified by:

findObject in class BaseParameter<java.util.Set<java.lang.String>>

Throws:

ParameterException