Package jetbrains.buildServer.controllers.parameters.embed

Class ParametersViewBean

java.lang.Object

jetbrains.buildServer.controllers.parameters.embed.ParametersViewBean

All Implemented Interfaces:

InheritableUserParametersHolder, InheritableUserParametersHolderEx, InternalParameters, ReadOnlyUserParameters, UserParametersHolder

public class ParametersViewBean
extends Object
implements ReadOnlyUserParameters, InheritableUserParametersHolderEx

Created 26.03.13 12:16

Author:

Eugene Petrenko (eugene.petrenko@jetbrains.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ParametersViewBean.RenderContext

Constructor Summary

Constructors

Constructor	Description
ParametersViewBean(String containerId, ParametersViewBeanFactory.Context context)

Method Summary

Modifier and Type	Method	Description
void	addParameter(Parameter param)	Adds parameter.
Collection<Parameter>	getInheritedParametersCollection()
Parameter	getOwnNonInheritedParameter(String paramName)	Own parameter without inherited parameter spec.
Parameter	getOwnParameter(String paramName)
Map<String,String>	getOwnParameters()
Collection<Parameter>	getOwnParametersCollection()
Collection<Parameter>	getOwnParametersWithoutInheritedSpec()
Parameter	getParameter(String paramName)
ParametersViewBean.RenderContext	getParameterContext(String name)
Collection<ParametersViewBean.RenderContext>	getParameterContexts()
Map<String,String>	getParameters()	Returns map of build and configuration parameters.
Collection<Parameter>	getParametersCollection()	Returns build and configuration parameters in single collection.
String	getParameterValue(String paramName)
void	removeParameter(String paramName)	Removes parameter.
ParameterRenderContext	updateParameter(Parameter parameter)
void	updateParametersContext(String key, Object value)

Methods inherited from class java.lang.Object

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

Methods inherited from interface jetbrains.buildServer.serverSide.InheritableUserParametersHolderEx

getOwnAndParentsNonInheritedParameter, getOwnAndParentsNonInheritedParameters

Methods inherited from interface jetbrains.buildServer.serverSide.InternalParameters

getBooleanInternalParameter, getBooleanInternalParameterOrTrue, getInternalParameterValue

Constructor Detail

ParametersViewBean

public ParametersViewBean(@NotNull
                          String containerId,
                          @NotNull
                          ParametersViewBeanFactory.Context context)

Method Detail

getParameterContext

@Nullable
public ParametersViewBean.RenderContext getParameterContext(@NotNull
                                                            String name)

getParametersCollection

@NotNull
public Collection<Parameter> getParametersCollection()

Description copied from interface: ReadOnlyUserParameters

Returns build and configuration parameters in single collection.

Specified by:

getParametersCollection in interface InheritableUserParametersHolder

Specified by:

getParametersCollection in interface ReadOnlyUserParameters

Returns:

see above

getParameter

@Nullable
public Parameter getParameter(@NotNull
                              String paramName)

Specified by:

getParameter in interface ReadOnlyUserParameters

getParameters

@NotNull
public Map<String,String> getParameters()

Description copied from interface: ReadOnlyUserParameters

Returns map of build and configuration parameters.

Specified by:

getParameters in interface InheritableUserParametersHolder

Specified by:

getParameters in interface ReadOnlyUserParameters

Returns:

build and configuration parameters map

getOwnParametersCollection

@NotNull
public Collection<Parameter> getOwnParametersCollection()

Specified by:

getOwnParametersCollection in interface InheritableUserParametersHolder

Returns:

own parameters, without inherited. Yet they would have inherited specs or values (if any).

getOwnParameters

@NotNull
public Map<String,String> getOwnParameters()

Specified by:

getOwnParameters in interface InheritableUserParametersHolder

Returns:

own parameters map, without inherited. Yet they would have inherited specs or values (if any).

getParameterValue

@Nullable
public String getParameterValue(@NotNull
                                String paramName)

Specified by:

getParameterValue in interface ReadOnlyUserParameters

Parameters:

paramName - parameter name

Returns:

value of the parameter with given name or null if there is no such parameter

getParameterContexts

@NotNull
public Collection<ParametersViewBean.RenderContext> getParameterContexts()

updateParametersContext

public void updateParametersContext(@NotNull
                                    String key,
                                    @NotNull
                                    Object value)

updateParameter

@NotNull
public ParameterRenderContext updateParameter(@NotNull
                                              Parameter parameter)

addParameter

public void addParameter(@NotNull
                         Parameter param)

Description copied from interface: UserParametersHolder

Adds parameter.

Specified by:

addParameter in interface UserParametersHolder

Parameters:

param - build or config parameter, the type is determined by parameter prefix

removeParameter

public void removeParameter(@NotNull
                            String paramName)

Description copied from interface: UserParametersHolder

Removes parameter.

Specified by:

removeParameter in interface UserParametersHolder

Parameters:

paramName - build or config parameter name, the type is determined by parameter prefix

getOwnParameter

@Nullable
public Parameter getOwnParameter(@NotNull
                                 String paramName)

Specified by:

getOwnParameter in interface InheritableUserParametersHolder

Parameters:

paramName - parameter name

Returns:

own parameter with given name or null if there is no such parameter

getOwnParametersWithoutInheritedSpec

@NotNull
public Collection<Parameter> getOwnParametersWithoutInheritedSpec()

Specified by:

getOwnParametersWithoutInheritedSpec in interface InheritableUserParametersHolder

Returns:

own parameters as is, with own parameters spec.

getInheritedParametersCollection

@NotNull
public Collection<Parameter> getInheritedParametersCollection()

Specified by:

getInheritedParametersCollection in interface InheritableUserParametersHolder

Returns:

collection of inherited parameters.

getOwnNonInheritedParameter

@Nullable
public Parameter getOwnNonInheritedParameter(@NotNull
                                             String paramName)

Description copied from interface: InheritableUserParametersHolderEx

Own parameter without inherited parameter spec.

Specified by:

getOwnNonInheritedParameter in interface InheritableUserParametersHolderEx

Returns: