com.atlassian.bitbucket.property

Class PropertyMap

java.lang.Object

com.atlassian.bitbucket.property.PropertyMap

All Implemented Interfaces:

Map<String,Object>

public class PropertyMap
extends Object
implements Map<String,Object>

Immutable collection of properties mapped by string keys. Allows for storing any object as a property value.

It is strongly encouraged that the property values can be marshalled to/from JSON, or they will not be included in REST responses.

See Also:

PropertySupport

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PropertyMap.Builder

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyMap	EMPTY

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<Map.Entry<String,Object>>	entrySet()
boolean	equals(Object obj)
Object	get(Object key)
<E,I extends Iterable<E>> I	getAs(String key, Class<I> iterableType, Class<E> elementType) Convenience method to return the property value as an instance of Iterable with element type E.
<T> T	getAs(String key, Class<T> expectedType)
int	hashCode()
boolean	isEmpty()
Set<String>	keySet()
Object	put(String key, Object value)
void	putAll(Map<? extends String,?> other)
Object	remove(Object key)
int	size()
String	toString()
Collection<Object>	values()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

EMPTY

public static final PropertyMap EMPTY

Method Detail

getAs

@Nullable
public <T> T getAs(@Nonnull
                             String key,
                             @Nonnull
                             Class<T> expectedType)

getAs

@Nullable
public <E,I extends Iterable<E>> I getAs(@Nonnull
                                                   String key,
                                                   @Nonnull
                                                   Class<I> iterableType,
                                                   @Nonnull
                                                   Class<E> elementType)

Convenience method to return the property value as an instance of Iterable with element type E.

Type Parameters:

E - type of the element

I - type of the iterable

Parameters:

key - property key

iterableType - class representing the expected type of the iterable

elementType - class representing the expected type of the elements

Returns:

property value, as an instance of I, or null, if this property map does not contain a property with key key

Throws:

ClassCastException - if the property exists, but is not of expected type iterableType

size

public int size()

Specified by:

size in interface Map<String,Object>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<String,Object>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<String,Object>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<String,Object>

get

public Object get(Object key)

Specified by:

get in interface Map<String,Object>

put

public Object put(String key,
                  Object value)

Specified by:

put in interface Map<String,Object>

remove

public Object remove(Object key)

Specified by:

remove in interface Map<String,Object>

putAll

public void putAll(@Nonnull
                   Map<? extends String,?> other)

Specified by:

putAll in interface Map<String,Object>

clear

public void clear()

Specified by:

clear in interface Map<String,Object>

keySet

@Nonnull
public Set<String> keySet()

Specified by:

keySet in interface Map<String,Object>

values

@Nonnull
public Collection<Object> values()

Specified by:

values in interface Map<String,Object>

entrySet

@Nonnull
public Set<Map.Entry<String,Object>> entrySet()

Specified by:

entrySet in interface Map<String,Object>

equals

public boolean equals(Object obj)

Specified by:

equals in interface Map<String,Object>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<String,Object>

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object