Package jetbrains.buildServer.serverSide

Interface TeamCityPropertiesProvider

All Known Implementing Classes:

AbstractPropertiesProvider, InMemoryPropertiesProvider, InternalPropertiesProvider

public interface TeamCityPropertiesProvider

A generic storage-agnostic TeamCity properties provider which may be used as a replacement for TeamCityProperties.

Since:

2018.1

Author:

Andrey Shcheglov <mailto:andrey.shcheglov@jetbrains.com>

See Also:

TeamCityProperties

Method Summary

Modifier and Type	Method	Description
boolean	getBoolean(String key)	Returns the property value as a boolean, or false if not set.
boolean	getBooleanOrTrue(String key)	Returns the property value as a boolean, or true if not set.
float	getFloat(String key)	Returns the property value as a float, or 0.0f if not set.
float	getFloat(String key, float defaultValue)	Returns the property value as a float.
int	getInteger(String key)	Returns the property value as an int, or 0 if not set.
int	getInteger(String key, int defaultValue)	Returns the property value as an int.
long	getLong(String key)	Returns the property value as a long, or 0L if not set.
long	getLong(String key, long defaultValue)	Returns the property value as a long.
String	getProperty(String key)	Returns the property value as a String, or an empty string if not set.
String	getProperty(String key, String defaultValue)	Returns the property value as a String.
String	getPropertyOrNull(String key)	Returns the property value as a String, or null if not set.
String	getPropertyOrNull(String key, String defaultValue)	Returns the property value as a String, or null if not set.

Method Detail

getBoolean

boolean getBoolean(@NotNull
                   String key)

Returns the property value as a boolean, or false if not set.

Parameters:

key - the property key.

Returns:

property value as a boolean.

See Also:

TeamCityProperties.getBoolean(String)

getBooleanOrTrue

boolean getBooleanOrTrue(@NotNull
                         String key)

Returns the property value as a boolean, or true if not set.

Parameters:

key - the property key.

Returns:

property value as a boolean.

See Also:

TeamCityProperties.getBooleanOrTrue(String)

getInteger

int getInteger(@NotNull
               String key)

Returns the property value as an int, or 0 if not set.

Parameters:

key - the property key.

Returns:

property value as an int.

See Also:

TeamCityProperties.getInteger(String)

getInteger

int getInteger(@NotNull
               String key,
               int defaultValue)

Returns the property value as an int.

Parameters:

key - the property key.

defaultValue - default value.

Returns:

property value as an int.

See Also:

TeamCityProperties.getInteger(String, int)

getFloat

float getFloat(@NotNull
               String key)

Returns the property value as a float, or 0.0f if not set.

Parameters:

key - the property key.

Returns:

property value as a float.

See Also:

TeamCityProperties.getFloat(String)

getFloat

float getFloat(@NotNull
               String key,
               float defaultValue)

Returns the property value as a float.

Parameters:

key - the property key.

defaultValue - default value.

Returns:

property value as a float.

See Also:

TeamCityProperties.getFloat(String, float)

getLong

long getLong(@NotNull
             String key)

Returns the property value as a long, or 0L if not set.

Parameters:

key - the property key.

Returns:

property value as a long.

See Also:

TeamCityProperties.getLong(String)

getLong

long getLong(@NotNull
             String key,
             long defaultValue)

Returns the property value as a long.

Parameters:

key - the property key.

defaultValue - default value.

Returns:

property value as a long.

See Also:

TeamCityProperties.getLong(String, long)

getProperty

@NotNull
String getProperty(@NotNull
                   String key)

Returns the property value as a String, or an empty string if not set.

Parameters:

key - the property key.

Returns:

property value as a String.

See Also:

TeamCityProperties.getProperty(String)

getProperty

@NotNull
String getProperty(@NotNull
                   String key,
                   @NotNull
                   String defaultValue)

Returns the property value as a String.

Parameters:

key - the property key.

defaultValue - default value.

Returns:

property value as a String.

See Also:

TeamCityProperties.getProperty(String, String)

getPropertyOrNull

@Nullable
String getPropertyOrNull(@NotNull
                         String key)

Returns the property value as a String, or null if not set.

Parameters:

key - the property key.

Returns:

property value as a String.

See Also:

TeamCityProperties.getPropertyOrNull(String)

getPropertyOrNull

@Nullable
String getPropertyOrNull(@NotNull
                         String key,
                         @Nullable
                         String defaultValue)

Returns the property value as a String, or null if not set.

Parameters:

key - the property key.

defaultValue - default value.

Returns:

property value as a String.

See Also:

TeamCityProperties.getPropertyOrNull(String, String)