Package jetbrains.buildServer.serverSide

Interface SettingsMap

All Known Implementing Classes:

SettingsMapImpl

public interface SettingsMap

Deprecated.

use SBuildType.getCustomDataStorage(String) or {SProject.getCustomDataStorage(String) instead

Provides the interface for the key-value storage (both are Strings). Thread-safe.

The settings may be associated with certain TeamCity objects (e.g. SProject). Note that the methods may not throw after this object is removed.

Keys and values are expected to be short or medium length (up to 1Mb). Big strings may cause performance problems.

Since:

7.0

Author:

Maxim Podkolzine (maxim.podkolzine@jetbrains.com)

See Also:

CustomSettings

Method Summary

Modifier and Type	Method	Description
String	getValue(String key)	Deprecated. Returns the value for the key, or null if there is no one.
String	remove(String key)	Deprecated. Removes and persists the entry associated with the key.
void	setValue(String key, String value)	Deprecated. Sets and persists the key / value entry.

Method Detail

getValue

@Nullable
String getValue(@NotNull
                String key)

Deprecated.

Returns the value for the key, or null if there is no one. The call may require the I/O operations, so can be potentially slow.

Parameters:

key - the key

Returns:

the value, or null

setValue

void setValue(@NotNull
              String key,
              @NotNull
              String value)

Deprecated.

Sets and persists the key / value entry. The call requires the I/O operations, hence can be slow.

Parameters:

key - the key

value - the value

remove

@Nullable
String remove(@NotNull
              String key)

Deprecated.

Removes and persists the entry associated with the key. The call requires the I/O operations, hence can be slow.

Parameters:

key - the key

Returns:

the previous value associated with the key, or null