Package com.polarion.platform.jobs.spi

Class PropertiesJobParameter

java.lang.Object

com.polarion.platform.jobs.spi.AbstractJobParameter

com.polarion.platform.jobs.spi.PropertiesJobParameter

All Implemented Interfaces:

IJobDescriptor.IJobParameter

public class PropertiesJobParameter
extends AbstractJobParameter

IJobDescriptor.IJobParameter implementation which holds values of type Properties.

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

• null
• Properties
• Map

Parameter type is IJobDescriptor.IJobParameterStructureType with unknown item type class String.

Version:

$Revision$ $Date$

Author:

Stepan Roh, Polarion Software

Constructor Summary

Constructors

Constructor	Description
PropertiesJobParameter(IJobDescriptor.IJobParameterGroup group, String name, String label)	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

PropertiesJobParameter

public PropertiesJobParameter(IJobDescriptor.IJobParameterGroup group,
 String name,
 String label)

Constructor.

Parameters:

group - job parameter group

name - job name

label - job label

Throws:

IllegalArgumentException - if group is null

IllegalArgumentException - if name is null

IllegalArgumentException - if label 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