Package org.xwiki.refactoring.splitter.criterion.naming

Class NamingCriterionParameters

java.lang.Object

org.xwiki.refactoring.splitter.criterion.naming.NamingCriterionParameters

@Unstable
public class NamingCriterionParameters
extends Object

Parameters for NamingCriterion.

Since:

14.10.2, 15.0RC1

Version:

$Id: ee9f858c4ad4be264facb593e881b46a96d6afaf $

Constructor Summary

Constructors

Constructor	Description
NamingCriterionParameters()

Method Summary

Modifier and Type	Method	Description
org.xwiki.model.reference.DocumentReference	getBaseDocumentReference()
<T> T	getParameter(String key)	Get the value of a given parameter.
<T> T	getParameter(String key, T defaultValue)	Get the value of a given parameter.
boolean	isUseTerminalPages()
void	setBaseDocumentReference(org.xwiki.model.reference.DocumentReference baseDocumentReference)	Set the base document reference.
Object	setParameter(String key, Object value)	Set the value of a parameter.
void	setUseTerminalPages(boolean useTerminalPages)	Set whether to generate terminal document references for the split parts or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

NamingCriterionParameters

public NamingCriterionParameters()

Method Detail

getParameter

public <T> T getParameter(String key)

Get the value of a given parameter.

Type Parameters:

T - the parameter type

Parameters:

key - the parameter name

Returns:

the value of the specified parameter

getParameter

public <T> T getParameter(String key,
                          T defaultValue)

Get the value of a given parameter.

Type Parameters:

T - the parameter type

Parameters:

key - the parameter value

defaultValue - the value to return if the specified parameter is not set

Returns:

the value of the specified parameter, if set, otherwise the default value

setParameter

public Object setParameter(String key,
                           Object value)

Set the value of a parameter.

Parameters:

key - the parameter name

value - the parameter value

Returns:

the previous value

getBaseDocumentReference

public org.xwiki.model.reference.DocumentReference getBaseDocumentReference()

Returns:

the base document reference used when creating document references for split parts

setBaseDocumentReference

public void setBaseDocumentReference(org.xwiki.model.reference.DocumentReference baseDocumentReference)

Set the base document reference.

Parameters:

baseDocumentReference - the new base document reference

isUseTerminalPages

public boolean isUseTerminalPages()

Returns:

true if the created document references should point to terminal pages, false otherwise

setUseTerminalPages

public void setUseTerminalPages(boolean useTerminalPages)

Set whether to generate terminal document references for the split parts or not.

Parameters:

useTerminalPages - true to generate terminal document references, false otherwise