public class

SpaceKeyParameter

java.lang.Object
↳	com.atlassian.confluence.macro.params.BaseParameter<T>
	↳	com.atlassian.confluence.macro.query.params.BooleanQueryFactoryParameter
		↳	com.atlassian.confluence.macro.query.params.SpaceKeyParameter

Class Overview

Parameter that presents space key search restrictions as SpaceCategoryQuery or InSpaceQuery implementations.

Inherited Fields

Public Constructors
	SpaceKeyParameter()
	SpaceKeyParameter(String defaultValue)

Public Methods
void	setSpaceManager(SpaceManager spaceManager)

Protected Methods
SearchQueryInterpreter	createSearchQueryInterpreter(MacroExecutionContext ctx)

Inherited Methods

@Deprecated final void	addParameterAlias(String name) This method is deprecated. since 3.1: this class is not thread safe and should not be mutated
abstract T	findObject(String paramValue, MacroExecutionContext ctx) Responsible for converting a macro parameter string value to its proper object representation (say "1" to new Integer(1))
final T	findValue(MacroExecutionContext ctx) Attempts to find the value from the specified `MacroExecutionContext` object.
final String	getDefaultValue() Returns the default value for this parameter if no match is found in the context.
final String	getParameter(Map<String, String> params, List names, String defaultValue) Returns the literal value of the parameter in the specified `Map`, using the specified `List` for names and aliases and the specified default value.
final String	getParameterValue(Map<String, String> params) Returns the literal value of the parameter, or the default value if none is present.
@Deprecated final void	setDefaultValue(String defaultValue) This method is deprecated. since 3.1: this class is not thread safe and should not be mutated
@Deprecated final void	setParameterNames(String[] names) This method is deprecated. since 3.1: this class is not thread safe and should not be mutated
final void	setValidate(boolean shouldValidate) Sets whether this parameter should attempt to validate its values.