Package jetbrains.buildServer.serverSide.parameters

Interface ParameterDescriptionFactory

All Known Implementing Classes:

ParameterDescriptionFactoryImpl

public interface ParameterDescriptionFactory

Since:

7.0

Author:

Eugene Petrenko (eugene.petrenko@gmail.com) Date: 09.09.11 12:44

Method Summary

Modifier and Type	Method	Description
ControlDescription	createDescription(String type, Map<String,String> attributes)	Creates control description for a specific type
ControlDescription	deserialize(org.jdom.Element parameterElement)	Deprecated. use deserialize(Element, UserParametersHolder) instead
ControlDescription	deserialize(org.jdom.Element parameterElement, UserParametersHolder parametersHolder)	Deserializes description from xml
ControlDescription	parseDescription(String desription)	Parse description
void	serialize(org.jdom.Element parameterElement, ControlDescription description)	Serialized description to parameter element
String	serializeSpec(ControlDescription description)	Serializes ControlDescription to string
ControlDescription	tryParseDescription(String description)	Tries to parse description

Method Detail

tryParseDescription

@Nullable
ControlDescription tryParseDescription(@Nullable
                                       String description)

Tries to parse description

Parameters:

description - serialized description text

Returns:

parsed description or null

Since:

7.0

See Also:

parseDescription(String)

createDescription

@NotNull
ControlDescription createDescription(@NotNull
                                     String type,
                                     @NotNull
                                     Map<String,String> attributes)

Creates control description for a specific type

Parameters:

type - type

attributes - parameter attributes

Returns:

description for given type

Since:

7.0

parseDescription

@NotNull
ControlDescription parseDescription(@NotNull
                                    String desription)
                             throws ParseException

Parse description

Parameters:

desription - serialized description text

Returns:

parsed description

Throws:

ParseException - on parse error

Since:

7.0

serialize

void serialize(@NotNull
               org.jdom.Element parameterElement,
               @NotNull
               ControlDescription description)

Serialized description to parameter element

Parameters:

parameterElement - element to serialized to

description - object

Since:

7.0

deserialize

@Nullable
ControlDescription deserialize(@NotNull
                               org.jdom.Element parameterElement,
                               @Nullable
                               UserParametersHolder parametersHolder)

Deserializes description from xml

Parameters:

parameterElement - element

Returns:

deserialized value or null

Since:

2024.3

deserialize

@Nullable
ControlDescription deserialize(@NotNull
                               org.jdom.Element parameterElement)

Deprecated.

use deserialize(Element, UserParametersHolder) instead

Deserializes description from xml

Parameters:

parameterElement - element

Returns:

deserialized value or null

serializeSpec

@NotNull
String serializeSpec(@NotNull
                     ControlDescription description)

Serializes ControlDescription to string

Parameters:

description - description to serialize

Returns:

string represendataion of type spec

Since:

7.0