Package jetbrains.buildServer.serverSide.parameters

Interface ParameterFactory

All Known Implementing Classes:

ParameterFactoryImpl

public interface ParameterFactory

Factory for Parameter interface

Since:

7.0

Author:

Eugene Petrenko (eugene.petrenko@gmail.com) Date: 08.09.11 18:48

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ParameterFactory.SecuredParameterResolver

Method Summary

Modifier and Type	Method	Description
Parameter	createOverriddenParameter(Parameter baseParameter, Parameter childParameter)	Creates an instance of parameter that overrides a parameter from parent
Parameter	createParameter(String name, String value, ControlDescription descriptionSpec)
Parameter	createParameter(Parameter param, String newRawValue)
Parameter	createParameter(Parameter param, Converter<String,String> valueTransform)
Parameter	createParameterWithNewName(Parameter parameter, String name)	Creates a copy of provided parameter with new name
Parameter	createSimpleParameter(String name, String value)
Parameter	createTypedParameter(String name, String value, String descriptionSpec)
Parameter	deserializeDBParameter(String name, String value)
Collection<Parameter>	deserializeDBParameters(Map<String,String> databaseParameters)
Collection<Parameter>	deserializeXmlParameters(org.jdom.Element parentElement, UserParametersHolder parametersHolder, ParameterFactory.SecuredParameterResolver securedValues)
String	getRawValue(Parameter parameter)	For given parameter returns its raw value.
Map<String,String>	getRawValues(Collection<Parameter> parameters)	Accepts collection of parameters, returns map from parameter name to its raw value.
boolean	isSecureParameter(ControlDescription cd)
<ObjectType> ObjectType	merge(ControlDescription baseCD, ObjectType base, ObjectType child, Function<ObjectType,String> toStringFunction, BiFunction<ObjectType,ObjectType,ObjectType> mergingFunction)
Parameter	mergeParameters(Parameter baseParameter, Parameter childParameter)	Merges 2 parameters
Map<String,String>	serializeDBParameters(SerializableParametersCollection collection)
void	serializeXmlParameters(Parameterized builder, SecureTokensProducer tokensProducer, SerializableParametersCollection collection)
Parameter	updateParameter(Parameter oldParameter, Parameter newParameter)

Method Detail

createSimpleParameter

@NotNull
Parameter createSimpleParameter(@NotNull
                                String name,
                                @NotNull
                                String value)

createTypedParameter

@NotNull
Parameter createTypedParameter(@NotNull
                               String name,
                               @NotNull
                               String value,
                               @NotNull
                               String descriptionSpec)

createParameter

@NotNull
Parameter createParameter(@NotNull
                          String name,
                          @NotNull
                          String value,
                          @Nullable
                          ControlDescription descriptionSpec)

createParameter

@NotNull
Parameter createParameter(@NotNull
                          Parameter param,
                          @NotNull
                          String newRawValue)

createParameter

@NotNull
Parameter createParameter(@NotNull
                          Parameter param,
                          @NotNull
                          Converter<String,String> valueTransform)

createParameterWithNewName

@NotNull
Parameter createParameterWithNewName(@NotNull
                                     Parameter parameter,
                                     @NotNull
                                     String name)

Creates a copy of provided parameter with new name

Parameters:

parameter - original parameter

name - new name

Returns:

copy of parameter with new name

Since:

9.0

updateParameter

@NotNull
Parameter updateParameter(@NotNull
                          Parameter oldParameter,
                          @NotNull
                          Parameter newParameter)

mergeParameters

Parameter mergeParameters(@Nullable
                          Parameter baseParameter,
                          @NotNull
                          Parameter childParameter)

Merges 2 parameters

Parameters:

baseParameter -

childParameter -

Returns:

1. If there is no base Parameter - child Parameter is returned 2. If base Parameter has Const spec - base Parameter is returned 3. If child value is not compliant with base spec - base Parameter is returned 4. A new Parameter instance with base spec and child value is returned otherwise

merge

@NotNull
<ObjectType> ObjectType merge(@Nullable
                              ControlDescription baseCD,
                              @Nullable
                              ObjectType base,
                              @NotNull
                              ObjectType child,
                              @NotNull
                              Function<ObjectType,String> toStringFunction,
                              @NotNull
                              BiFunction<ObjectType,ObjectType,ObjectType> mergingFunction)

createOverriddenParameter

@NotNull
Parameter createOverriddenParameter(@NotNull
                                    Parameter baseParameter,
                                    @NotNull
                                    Parameter childParameter)

Creates an instance of parameter that overrides a parameter from parent

Parameters:

baseParameter - base parameter to be overridden

childParameter - child parameter to be used

Returns:

new instance of parameter

serializeXmlParameters

void serializeXmlParameters(@NotNull
                            Parameterized builder,
                            @NotNull
                            SecureTokensProducer tokensProducer,
                            @NotNull
                            SerializableParametersCollection collection)

deserializeXmlParameters

@NotNull
Collection<Parameter> deserializeXmlParameters(@NotNull
                                               org.jdom.Element parentElement,
                                               @Nullable
                                               UserParametersHolder parametersHolder,
                                               @Nullable
                                               ParameterFactory.SecuredParameterResolver securedValues)

deserializeDBParameters

@NotNull
Collection<Parameter> deserializeDBParameters(@NotNull
                                              Map<String,String> databaseParameters)

deserializeDBParameter

@NotNull
Parameter deserializeDBParameter(@NotNull
                                 String name,
                                 @NotNull
                                 String value)

serializeDBParameters

@NotNull
Map<String,String> serializeDBParameters(@NotNull
                                               SerializableParametersCollection collection)

getRawValues

@NotNull
Map<String,String> getRawValues(@NotNull
                                      Collection<Parameter> parameters)

Accepts collection of parameters, returns map from parameter name to its raw value. Results are unpredictable if collection of parameters contains two parameters with the same name.

Parameters:

parameters - parameters collection

Returns:

map from name to parameter raw value

Since:

10.0

getRawValue

@NotNull
String getRawValue(@NotNull
                   Parameter parameter)

For given parameter returns its raw value.

Parameters:

parameter - parameter

Returns:

raw value of given parameter

Since:

10.0

isSecureParameter

boolean isSecureParameter(@Nullable
                          ControlDescription cd)

Parameters:

cd - parameter specification, if null then this method always returns false

Returns:

true if parameter specification corresponds to secure parameter

Since:

2017.1