com.atlassian.sal.api.usersettings

Interface UserSettingsBuilder

All Known Implementing Classes:

DefaultUserSettings.Builder

public interface UserSettingsBuilder

A builder for UserSettings

Method Summary

Modifier and Type	Method and Description
UserSettings	build()
io.atlassian.fugue.Option<Object>	get(String key)
Set<String>	getKeys()
UserSettingsBuilder	put(String key, boolean value) add an extra entry to the builder, overwriting any existing value stored against key (regardless of type)
UserSettingsBuilder	put(String key, long value) add an extra entry to the builder, overwriting any existing value stored against key (regardless of type)
UserSettingsBuilder	put(String key, String value) add an extra entry to the builder, overwriting any existing value stored against key (regardless of type)
UserSettingsBuilder	remove(String key) remove an entry from the builder

Method Detail

put

UserSettingsBuilder put(String key,
                        String value)

add an extra entry to the builder, overwriting any existing value stored against key (regardless of type)

Parameters:

key - the key to store the value against

value - the non-null String to store, length cannot be longer than UserSettingsService.MAX_KEY_LENGTH

Returns:

this builder

Throws:

IllegalArgumentException - if value is null, or value is longer than UserSettingsService.MAX_STRING_VALUE_LENGTH characters, or key is null or longer than UserSettingsService.MAX_KEY_LENGTH characters.

put

UserSettingsBuilder put(String key,
                        boolean value)

add an extra entry to the builder, overwriting any existing value stored against key (regardless of type)

Parameters:

key - the key to store the value against

value - the boolean to store

Returns:

this builder

Throws:

IllegalArgumentException - if key is null or longer than UserSettingsService.MAX_KEY_LENGTH characters.

put

UserSettingsBuilder put(String key,
                        long value)

add an extra entry to the builder, overwriting any existing value stored against key (regardless of type)

Parameters:

key - the key to store the value against

value - the long to store

Returns:

this builder

Throws:

IllegalArgumentException - if key is null or longer than UserSettingsService.MAX_KEY_LENGTH characters.

remove

UserSettingsBuilder remove(String key)

remove an entry from the builder

Parameters:

key - the key for the entry to remove

Returns:

this builder

Throws:

IllegalArgumentException - if key is null or longer than UserSettingsService.MAX_KEY_LENGTH characters.

get

io.atlassian.fugue.Option<Object> get(String key)

Parameters:

key - the setting key being queried

Returns:

a Some containing the value stored against key if one exists, a Option.none() otherwise. Values can be of type String, Boolean or Long.

Throws:

IllegalArgumentException - if key is null or longer than UserSettingsService.MAX_KEY_LENGTH characters.

getKeys

Set<String> getKeys()

Returns:

the set of keys known to this UserSettings

build

UserSettings build()

Returns:

an immutable UserSettings matching the contents of this builder