Package com.polarion.platform.jobs.spi

Class PathJobParameter

java.lang.Object

com.polarion.platform.jobs.spi.AbstractJobParameter

com.polarion.platform.jobs.spi.PathJobParameter

All Implemented Interfaces:

IJobDescriptor.IJobParameter

public class PathJobParameter
extends AbstractJobParameter

Representing IJobDescriptor.IJobParameter of type Path.

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

• null
• Path
• CharSequence

If arbitrary object is passed then Paths.get(String, String...) factory method is invoked with stringified object.

Since:

3.22.2

See Also:

• AbstractJobParameter

Constructor Summary

Constructors

Constructor	Description
PathJobParameter(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 Path.

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

PathJobParameter

public PathJobParameter(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)

Helper method for conversion from arbitrary Object to Path.

Parameters:

value - arbitrary value (may be null)

Returns:

converted value or null

Throws:

IllegalArgumentException - if value cannot be converted