Package com.polarion.platform.jobs.spi

Class ArrayJobParameter

java.lang.Object

com.polarion.platform.jobs.spi.AbstractJobParameter

com.polarion.platform.jobs.spi.ArrayJobParameter

All Implemented Interfaces:

IJobDescriptor.IJobParameter

public class ArrayJobParameter
extends AbstractJobParameter

Simple array IJobDescriptor.IJobParameter.

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

• null
• one-item Map of any type
• List of any type
• array of any type

If item of other type than class from associated IJobDescriptor.IJobParameterType.getTypeClass() or its subclass is encountered than the value is converted by passing its stringified value to the single-string-argument constructor of associated IJobDescriptor.IJobParameterType.getTypeClass().

AbstractJobParameter.getType() returns instance of IJobDescriptor.IJobParameterListType.

Since:

3.3.1

Version:

$Revision$ $Date$

Author:

Stepan Roh

See Also:

• AbstractJobParameter
• SimpleJobParameter

Constructor Summary

Constructors

Constructor	Description
ArrayJobParameter(IJobDescriptor.IJobParameterGroup group, String name, String label, IJobDescriptor.IJobParameterType itemType)	Constructor.

Method Summary

Modifier and Type	Method	Description
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

ArrayJobParameter

public ArrayJobParameter(IJobDescriptor.IJobParameterGroup group,
 String name,
 String label,
 IJobDescriptor.IJobParameterType itemType)

Constructor.

Parameters:

group - job parameter group

name - job name

label - job label

itemType - parameter type of array component

Throws:

IllegalArgumentException - if group is null

IllegalArgumentException - if name is null

IllegalArgumentException - if label is null

IllegalArgumentException - if itemType is null

Method Details

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