Package jetbrains.buildServer.parameters.impl

Class AbstractMapParametersProvider

java.lang.Object

jetbrains.buildServer.parameters.impl.AbstractMapParametersProvider

All Implemented Interfaces:

ContainsAwareParametersProvider, MapParametersProvider, ParametersProvider

Direct Known Subclasses:

MapParametersProviderImpl

public class AbstractMapParametersProvider
extends Object
implements MapParametersProvider, ContainsAwareParametersProvider

Created by Eugene Petrenko (eugene.petrenko@gmail.com) Date: 14.06.11 20:01

Constructor Summary

Constructors

Constructor	Description
AbstractMapParametersProvider(Map<String,String> parameters)	Create map provider wrapping a given map.

Method Summary

Modifier and Type	Method	Description
boolean	contains(String key)	Returns true if this parameters provider contains specified key
String	get(String key)
Map<String,String>	getAll()	Allows to get map of the provided parameters.
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

AbstractMapParametersProvider

public AbstractMapParametersProvider(@NotNull
                                     Map<String,String> parameters)

Create map provider wrapping a given map. No copy is done, all requests are redirected to the given map Given map would be used for both read and writes

Parameters:

parameters - map to adapt to MapParametersProvider

Method Detail

get

public String get(@NotNull
                  String key)

Specified by:

get in interface ParametersProvider

Parameters:

key - the name of the parameter

Returns:

the value associated with a key, or null if the parameter with the key cannot be found.

contains

public boolean contains(@NotNull
                        String key)

Description copied from interface: ContainsAwareParametersProvider

Returns true if this parameters provider contains specified key

Specified by:

contains in interface ContainsAwareParametersProvider

Parameters:

key - key of interest

Returns:

see above

remove

public String remove(@NotNull
                     String key)

Specified by:

remove in interface MapParametersProvider

put

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

Specified by:

put in interface MapParametersProvider

putAll

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

Allows to add map of parameters into the backing map

Specified by:

putAll in interface MapParametersProvider

Parameters:

fromMap - the map to copy parameters from

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()

Description copied from interface: ParametersProvider

Allows to get map of the provided parameters. Note that get method can provide more parameters then are returned by this method. However, all the parameters returned by this method should also be available via get method.

Specified by:

getAll in interface ParametersProvider

Returns:

copy of the backed data

toString

public String toString()

Overrides:

toString in class Object