Package com.github.toolarium.processing.engine.dto.parameter

Class ParameterDefinition

java.lang.Object

com.github.toolarium.processing.engine.dto.parameter.ParameterDefinition

All Implemented Interfaces:

IParameterDefinition, java.io.Serializable

public class ParameterDefinition
extends java.lang.Object
implements IParameterDefinition, java.io.Serializable

Implements the IParameterDefinition.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ParameterDefinition(com.github.toolarium.processing.unit.dto.ParameterDefinition parameterDefinition)	Constructor for ParameterDefinition

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
java.lang.String	getDefaultValue()	Gets the default value
java.lang.String	getDescription()	Gets the parameter description.
java.lang.String	getKey()	Gets the key.
int	getMaxOccurs()	Get the max occurs.
int	getMinOccurs()	Get the min occurs.
com.github.toolarium.processing.unit.dto.ParameterValueType	getValueType()	Gets the data type
int	hashCode()
boolean	hasValueToProtect()	Check if the value of this parameter should be protected.
boolean	isEmptyValueAllowed()	Check if an empty value is allowed or not.
boolean	isOptional()	Check if the key is optional or not.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ParameterDefinition

public ParameterDefinition(com.github.toolarium.processing.unit.dto.ParameterDefinition parameterDefinition)

Constructor for ParameterDefinition

Parameters:

parameterDefinition - the parameter definition

Method Detail

getKey

public java.lang.String getKey()

Description copied from interface: IParameterDefinition

Gets the key.

Specified by:

getKey in interface IParameterDefinition

Returns:

the key

See Also:

IParameterDefinition.getKey()

getValueType

public com.github.toolarium.processing.unit.dto.ParameterValueType getValueType()

Description copied from interface: IParameterDefinition

Gets the data type

Specified by:

getValueType in interface IParameterDefinition

Returns:

the data type

See Also:

IParameterDefinition.getValueType()

getDefaultValue

public java.lang.String getDefaultValue()

Description copied from interface: IParameterDefinition

Gets the default value

Specified by:

getDefaultValue in interface IParameterDefinition

Returns:

the default value

See Also:

IParameterDefinition.getDefaultValue()

isOptional

public boolean isOptional()

Description copied from interface: IParameterDefinition

Check if the key is optional or not.

Specified by:

isOptional in interface IParameterDefinition

Returns:

true if it is optional

See Also:

IParameterDefinition.isOptional()

getMinOccurs

public int getMinOccurs()

Description copied from interface: IParameterDefinition

Get the min occurs.

Specified by:

getMinOccurs in interface IParameterDefinition

Returns:

the min occurs.

See Also:

IParameterDefinition.getMinOccurs()

getMaxOccurs

public int getMaxOccurs()

Description copied from interface: IParameterDefinition

Get the max occurs.

Specified by:

getMaxOccurs in interface IParameterDefinition

Returns:

the max occurs.

See Also:

IParameterDefinition.getMaxOccurs()

isEmptyValueAllowed

public boolean isEmptyValueAllowed()

Description copied from interface: IParameterDefinition

Check if an empty value is allowed or not.

Specified by:

isEmptyValueAllowed in interface IParameterDefinition

Returns:

true if an empty value is allowed

See Also:

IParameterDefinition.isEmptyValueAllowed()

hasValueToProtect

public boolean hasValueToProtect()

Description copied from interface: IParameterDefinition

Check if the value of this parameter should be protected.

Specified by:

hasValueToProtect in interface IParameterDefinition

Returns:

true if the value of this parameter should be protected; otherwise false.

See Also:

IParameterDefinition.hasValueToProtect()

getDescription

public java.lang.String getDescription()

Description copied from interface: IParameterDefinition

Gets the parameter description.

Specified by:

getDescription in interface IParameterDefinition

Returns:

The parameter description

See Also:

IParameterDefinition.getDescription()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

See Also:

Object.hashCode()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(java.lang.Object)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()