Interface Parameter<T>
-
- All Known Implementing Classes:
AuthorParameter
,BaseParameter
,BooleanQueryFactoryParameter
,ContentTypeParameter
,LabelParameter
,MaxResultsParameter
,MultiValueParameter
,SearchSortParameter
,SpaceKeyParameter
public interface Parameter<T>
Provides a way to retrieve more complex values from macro parameters.- Since:
- 2.9
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description T
findValue(MacroExecutionContext ctx)
Attempts to find the value from the specifiedMacroExecutionContext
object.void
setValidate(boolean shouldValidate)
Sets whether this parameter should attempt to validate its values.
-
-
-
Method Detail
-
findValue
T findValue(MacroExecutionContext ctx) throws ParameterException
Attempts to find the value from the specifiedMacroExecutionContext
object.- Parameters:
ctx
- The execution context for the macro.- Returns:
- The parameter value.
- Throws:
ParameterException
- if there was a problem while processing the parameter.
-
setValidate
void setValidate(boolean shouldValidate)
Sets whether this parameter should attempt to validate its values.- Parameters:
shouldValidate
- true if this parameter should attempt to validate- Since:
- 2.10
-
-