com.atlassian.confluence.macro.params

Class MaxResultsParameter

java.lang.Object

com.atlassian.confluence.macro.params.BaseParameter<Integer>

com.atlassian.confluence.macro.params.MaxResultsParameter

All Implemented Interfaces:

Parameter<Integer>

public class MaxResultsParameter
extends BaseParameter<Integer>

Parameter that resolves an Integer as the maximum number of results to return to a query.

Since:

2.9

Field Summary

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

shouldValidate

Constructor Summary

Constructors

Constructor and Description
MaxResultsParameter()
MaxResultsParameter(List<String> names, String defaultValue)
MaxResultsParameter(String defaultValue)

Method Summary

Modifier and Type	Method and Description
protected Integer	findObject(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

MaxResultsParameter

public MaxResultsParameter()

MaxResultsParameter

public MaxResultsParameter(String defaultValue)

MaxResultsParameter

public MaxResultsParameter(List<String> names,
                           String defaultValue)

Method Detail

findObject

protected Integer findObject(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<Integer>

Throws:

ParameterException