jetbrains.buildServer.parameters

Interface ParametersProvider

All Known Subinterfaces:

CompositeParametersProvider, ContainsAwareParametersProvider, MapParametersProvider

All Known Implementing Classes:

AbstractMapParametersProvider, AliasParametersProvider, CaseInsensitiveParametersProvider, CompositeParametersProviderImpl, DelegatingParametersProvider, MapParametersProviderImpl, PrefixedParametersProvider

public interface ParametersProvider

A map of parameters where key is parameter name and value is parameter value.

Author:

Yegor.Yarko Date: 10.06.2008

Method Summary

Modifier and Type	Method and Description
java.lang.String	get(java.lang.String key)
java.util.Map<java.lang.String,java.lang.String>	getAll() Allows to get map of the provided parameters.
int	size() Returns the number of parameters in this parameters provider.

Method Detail

get

@Nullable
java.lang.String get(@NotNull
                               java.lang.String key)

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.

size

int size()

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

getAll

java.util.Map<java.lang.String,java.lang.String> getAll()

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.

Returns:

copy of the backed data