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

java.lang.Object
  extended by com.atlassian.confluence.macro.params.BaseParameter<BooleanQueryFactory>
      extended by com.atlassian.confluence.macro.query.params.BooleanQueryFactoryParameter
All Implemented Interfaces:
Parameter<BooleanQueryFactory>
Direct Known Subclasses:
ContentTypeParameter, LabelParameter, SpaceKeyParameter

public abstract class BooleanQueryFactoryParameter
extends BaseParameter<BooleanQueryFactory>

Parameter that parses its values into BooleanQueryFactory instances.

Since:
2.9

Field Summary
 
Fields inherited from class com.atlassian.confluence.macro.params.BaseParameter
shouldValidate
 
Constructor Summary
protected BooleanQueryFactoryParameter(java.util.List<java.lang.String> names, java.lang.String defaultValue)
           
protected BooleanQueryFactoryParameter(java.lang.String[] names, java.lang.String defaultValue)
           
protected BooleanQueryFactoryParameter(java.lang.String name, java.lang.String defaultValue)
           
 
Method Summary
protected  BooleanQueryFactory createBooleanQueryFactory(java.lang.String paramValue, MacroExecutionContext ctx)
           
protected abstract  SearchQueryInterpreter createSearchQueryInterpreter(MacroExecutionContext ctx)
           
protected  BooleanQueryFactory 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))
 void setDefaultInclusionCriteria(InclusionCriteria criteria)
          Sets the default InclusionCriteria value to use in the underlying parser.
 
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

BooleanQueryFactoryParameter

protected BooleanQueryFactoryParameter(java.lang.String name,
                                       java.lang.String defaultValue)

BooleanQueryFactoryParameter

protected BooleanQueryFactoryParameter(java.lang.String[] names,
                                       java.lang.String defaultValue)

BooleanQueryFactoryParameter

protected BooleanQueryFactoryParameter(java.util.List<java.lang.String> names,
                                       java.lang.String defaultValue)
Method Detail

setDefaultInclusionCriteria

public final void setDefaultInclusionCriteria(InclusionCriteria criteria)
Sets the default InclusionCriteria value to use in the underlying parser.

Parameters:
criteria - the default InclusionCriteria to use

findObject

protected final BooleanQueryFactory 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<BooleanQueryFactory>
Throws:
ParameterException

createSearchQueryInterpreter

protected abstract SearchQueryInterpreter createSearchQueryInterpreter(MacroExecutionContext ctx)

createBooleanQueryFactory

protected BooleanQueryFactory createBooleanQueryFactory(java.lang.String paramValue,
                                                        MacroExecutionContext ctx)
                                                 throws ParameterException
Throws:
ParameterException


Copyright © 2003-2014 Atlassian. All Rights Reserved.