Package jetbrains.buildServer.parameters.impl

Class AliasParametersProvider

java.lang.Object

jetbrains.buildServer.parameters.impl.AliasParametersProvider

All Implemented Interfaces:

MapParametersProvider, ParametersProvider

public class AliasParametersProvider
extends Object
implements MapParametersProvider

Allows to find a parameter by both its original key and alias key.

Author:

Yegor.Yarko Date: 09.06.2008

Constructor Summary

Constructors

Constructor	Description
AliasParametersProvider(MapParametersProvider source)

Method Summary

Modifier and Type	Method	Description
void	addAlias(String alias, String originalName)
String	get(String key)
Map<String,String>	getAll()	Returns a copy of the source map.
void	put(String key, String value)
void	putAll(Map<String,String> fromMap)	Allows to add map of parameters into the backing map
String	remove(String key)
int	size()	Returns the number of parameters in this parameters provider.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AliasParametersProvider

public AliasParametersProvider(MapParametersProvider source)

Method Detail

size

public int size()

Description copied from interface: ParametersProvider

Returns the number of parameters in this parameters provider. This is the size of the map returned by getAll method.

Specified by:

size in interface ParametersProvider

getAll

public Map<String,String> getAll()

Returns a copy of the source map. Note that the aliased values are not included.

Specified by:

getAll in interface ParametersProvider

Returns:

a copy of the source map

get

public String get(@NotNull
                  String key)

Specified by:

get in interface ParametersProvider

Parameters:

key - the name of the parameter

Returns:

value from the backed map corresponding to the key, or (if not found) corresponding to alias of the key.

put

public void put(@NotNull
                String key,
                @NotNull
                String value)

Specified by:

put in interface MapParametersProvider

remove

@Nullable
public String remove(@NotNull
                     String key)

Specified by:

remove in interface MapParametersProvider

putAll

public void putAll(@NotNull
                   Map<String,String> fromMap)

Description copied from interface: MapParametersProvider

Allows to add map of parameters into the backing map

Specified by:

putAll in interface MapParametersProvider

Parameters:

fromMap - the map to copy parameters from

addAlias

public void addAlias(String alias,
                     String originalName)

toString

public String toString()

Overrides:

toString in class Object