Package com.e1c.g5.v8.dt.check

Class CheckParameterDefinition

java.lang.Object

com.e1c.g5.v8.dt.check.CheckParameterDefinition

public final class CheckParameterDefinition
extends Object

The definition of a single parameter of a parametrized check. This definition defines the parameter of the check and can be added during the cycle of the check configuration ICheck.configureContextCollector(com.e1c.g5.v8.dt.check.ICheckDefinition) Defined parameter values and titles could be overriden via the extension point "com.e1c.g5.v8.dt.checks.check" during integration of the check into the check bundle Defined parameters are accessible during the check cycle ICheck.check(Object, com.e1c.g5.v8.dt.check.ICheckResultAcceptor, com.e1c.g5.v8.dt.check.ICheckParameters, org.eclipse.core.runtime.IProgressMonitor) in form of ICheckParameters-accessed values

Constructor Summary

Constructors

Constructor	Description
CheckParameterDefinition(String name)	Constructs an instance of the definition
CheckParameterDefinition(String name, Class<?> type)	Constructs an isntance of the definition
CheckParameterDefinition(String name, Class<?> type, String defaultValue, String title)	Constructs an instance of the definition with the default value and title

Method Summary

Modifier and Type	Method	Description
String	getDefaultValue()	Gets the default value if set
String	getName()	Gets the name of the parameter
String	getTitle()	The title of the parameter, if any
Class<?>	getType()	Gets the type of the parameter
void	setDefaultValue(String defaultValue)	Sets the default value for the parameter
void	setTitle(String title)	The title of the parameter
void	setType(Class<?> type)	Sets the type of the parameter

Methods inherited from class java.lang.Object

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

Constructor Details

CheckParameterDefinition

public CheckParameterDefinition(String name)

Constructs an instance of the definition

Parameters:

name - The name of the parameter. May not be null

CheckParameterDefinition

public CheckParameterDefinition(String name,
 Class<?> type)

Constructs an isntance of the definition

Parameters:

name - The name of the parameter. May not be null

type - The type of the parameter. May not be null

CheckParameterDefinition

public CheckParameterDefinition(String name,
 Class<?> type,
 String defaultValue,
 String title)

Constructs an instance of the definition with the default value and title

Parameters:

name - The name of the parameter. May not be null

type - The type of the parameter. May not be null

defaultValue - The default value, in plain string format conforming the requirements of the chosed parameter type. May be null

title - The title of the parameter to show on the check preferences page. May be null

Method Details

getDefaultValue

public String getDefaultValue()

Gets the default value if set

Returns:

The default value. Could be null

getName

public String getName()

Gets the name of the parameter

Returns:

The name of the parameter. May not be null

getTitle

public String getTitle()

The title of the parameter, if any

Returns:

The title of the parameter, may not be null

getType

public Class<?> getType()

Gets the type of the parameter

Returns:

The type of the parameter. May not be null

setDefaultValue

public void setDefaultValue(String defaultValue)

Sets the default value for the parameter

Parameters:

defaultValue - The default value to set. May be null

setTitle

public void setTitle(String title)

The title of the parameter

Parameters:

title - The title to set. May be null

setType

public void setType(Class<?> type)

Sets the type of the parameter

Parameters:

type - The type to set. May not be null