Package com.polarion.platform.jobs.spi

Class SimpleJobParameter

java.lang.Object

com.polarion.platform.jobs.spi.AbstractJobParameter

com.polarion.platform.jobs.spi.SimpleJobParameter

All Implemented Interfaces:

IJobDescriptor.IJobParameter

public class SimpleJobParameter
extends AbstractJobParameter

Simple IJobDescriptor.IJobParameter.

Value passed to convertValue(Object) can be one of these:

• null
• class from associated IJobDescriptor.IJobParameterType.getTypeClass() or its subclass
• arbitrary object

If arbitrary object is passed then single-string-argument constructor of associated IJobDescriptor.IJobParameterType.getTypeClass() is invoked with stringified object.

Version:

$Revision$ $Date$

Author:

Stepan Roh, Polarion Software

See Also:

• AbstractJobParameter

Constructor Summary

Constructors

Constructor	Description
SimpleJobParameter(IJobDescriptor.IJobParameterGroup group, String name, String label, IJobDescriptor.IJobParameterType type)	Constructor.

Method Summary

Modifier and Type	Method	Description
static Object	convertSimpleValue(IJobDescriptor.IJobParameterType type, Object value)	Simple conversion to given type.
Object	convertValue(Object value)	Helper method for conversion from arbitrary Object to desired class.

Methods inherited from class com.polarion.platform.jobs.spi.AbstractJobParameter

getDefaultValue, getDescription, getGroup, getLabel, getName, getType, isActive, isRequired, setActive, setDefaultValue, setDescription, setLabel, setRequired

Methods inherited from class java.lang.Object

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

Constructor Details

SimpleJobParameter

public SimpleJobParameter(IJobDescriptor.IJobParameterGroup group,
 String name,
 String label,
 IJobDescriptor.IJobParameterType type)

Constructor.

Parameters:

group - job parameter group

name - job name

label - job label

type - parameter type

Throws:

IllegalArgumentException - if group is null

IllegalArgumentException - if name is null

IllegalArgumentException - if label is null

IllegalArgumentException - if type is null

Method Details

convertSimpleValue

public static Object convertSimpleValue(IJobDescriptor.IJobParameterType type,
 Object value)

Simple conversion to given type.

Parameters:

type - target type

value - source value

Returns:

converted value

Since:

3.3.1

See Also:

• convertValue(Object)

convertValue

public Object convertValue(Object value)

Description copied from interface: IJobDescriptor.IJobParameter

Helper method for conversion from arbitrary Object to desired class.

It is not required that null is converted to null or that non-null is not converted to null.

Parameters:

value - arbitrary value (may be null)

Returns:

converted value or null