Package jetbrains.buildServer.controllers.buildType

Class ParameterInfo

java.lang.Object

jetbrains.buildServer.controllers.buildType.ParameterInfo

All Implemented Interfaces:

Comparable<ParameterInfo>

public class ParameterInfo
extends Object
implements Comparable<ParameterInfo>

Author:

Pavel.Sher Date: 03.06.2006

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ParameterInfo.Kind

Constructor Summary

Constructors

Constructor	Description
ParameterInfo(Parameter param, String description)

Method Summary

Modifier and Type	Method	Description
int	compareTo(ParameterInfo parameter)
String	getDescription()
int	getId()
String	getInheritanceOrigin()
String	getName()
String	getNameWithPrefix()
String	getNameWithPrefixEscaped()
String	getOwnValue()
String	getParameterSpec()
String	getRawValue()
String	getReference()
String	getValue()	Value to be shown to used.
boolean	isEditableOrigin()
boolean	isInherited()
boolean	isInvalidParameterName()
boolean	isReadOnly()
boolean	isRedefined()
boolean	isUndefined()
boolean	isValidParameterName()
static int	makeParameterId(String name)
void	setEditableOrigin(boolean editableOrigin)
void	setInherited(String origin)
void	setOwnValue(String ownValue)
void	setParameterSpec(String spec)
void	setRawValue(String rawValue)
void	setRedefined(boolean redefined)
void	setUndefined(boolean undefined)
void	setValue(String value)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ParameterInfo

public ParameterInfo(@NotNull
                     Parameter param,
                     @NotNull
                     String description)

Method Detail

getId

public int getId()

makeParameterId

public static int makeParameterId(String name)

getName

public String getName()

getValue

public String getValue()

Value to be shown to used. This value may be preprocessed by custom parameters controls by calling ParameterControlViewPresenter.presentParameterValue(jetbrains.buildServer.controllers.parameters.ParameterContext, String) method in custom control.

Returns:

viewable parameter value.

See Also:

getRawValue()

setValue

public void setValue(String value)

setOwnValue

public void setOwnValue(String ownValue)

getOwnValue

public String getOwnValue()

getRawValue

public String getRawValue()

Returns:

raw value, i.e. same value as in server model

See Also:

getValue()

setRawValue

public void setRawValue(String rawValue)

getDescription

public String getDescription()

getNameWithPrefix

public String getNameWithPrefix()

getNameWithPrefixEscaped

public String getNameWithPrefixEscaped()

getReference

public String getReference()

isInherited

public boolean isInherited()

getInheritanceOrigin

public String getInheritanceOrigin()

setInherited

public void setInherited(String origin)

getParameterSpec

@Nullable
public String getParameterSpec()

setParameterSpec

public void setParameterSpec(@Nullable
                             String spec)

isUndefined

public boolean isUndefined()

setUndefined

public void setUndefined(boolean undefined)

isInvalidParameterName

public boolean isInvalidParameterName()

isValidParameterName

public boolean isValidParameterName()

setRedefined

public void setRedefined(boolean redefined)

isRedefined

public boolean isRedefined()

isReadOnly

public boolean isReadOnly()

setEditableOrigin

public void setEditableOrigin(boolean editableOrigin)

isEditableOrigin

public boolean isEditableOrigin()

Returns:

true if current user can edit this parameter

compareTo

public int compareTo(@NotNull
                     ParameterInfo parameter)

Specified by:

compareTo in interface Comparable<ParameterInfo>

toString

public String toString()

Overrides:

toString in class Object