Package com.polarion.alm.builder.spi

Class BuildArtifactJobParameter

java.lang.Object

com.polarion.platform.jobs.spi.AbstractJobParameter

com.polarion.alm.builder.spi.BuildArtifactJobParameter

All Implemented Interfaces:

IJobDescriptor.IJobParameter

public class BuildArtifactJobParameter
extends AbstractJobParameter

IJobDescriptor.IJobParameter implementation which holds values of type IBuildArtifact.

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

• null
• IBuildArtifact
• IBuildArtifactSelector
• GROUP_ID:ARTIFACT_ID[:REPOSITORY_TAG] (e.g. "test:test-maven2:tags/tag1")

If selector is passed (either as a class or in textual form), attempt to find this artifact is done. If more than one artifact is found and IJobUnit is known then its IJobUnit.getScope() is used for narrowing the search results. Conversion succeeds if and only if exactly one artifact is found.

Parameter type is IJobDescriptor.IJobParameterPrimitiveType with type class IBuildArtifact.

Version:

$Revision$ $Date$

Author:

Stepan Roh, Polarion Software

See Also:

• AbstractJobParameter

Constructor Summary

Constructors

Constructor	Description
BuildArtifactJobParameter(IJobDescriptor.IJobParameterGroup group, String name, String label, IBuilderService builder, IJobUnit unit)	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

BuildArtifactJobParameter

public BuildArtifactJobParameter(IJobDescriptor.IJobParameterGroup group,
 String name,
 String label,
 IBuilderService builder,
 IJobUnit unit)

Constructor.

Parameters:

group - job parameter group

name - job name

label - job label

builder - builder service

unit - job unit (can be null)

Throws:

IllegalArgumentException - if group is null

IllegalArgumentException - if name is null

IllegalArgumentException - if label is null

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