Package org.apache.sis.metadata

Class ValueMap

java.lang.Object

java.util.AbstractMap<String,V>

org.apache.sis.metadata.PropertyMap<Object>

org.apache.sis.metadata.ValueMap

All Implemented Interfaces:

Map<String,Object>

final class ValueMap
extends PropertyMap<Object>

A view of a metadata object as a map. Keys are property names and values are the value returned by the getFoo() method using reflection.

Since:

0.3

Version:

1.2

See Also:

• MetadataStandard.asValueMap(Object, Class, KeyNamePolicy, ValueExistencePolicy)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private final class	ValueMap.Entries	View of the entries contained in the map.
private final class	ValueMap.Iter	The iterator over the ValueMap.Property elements contained in an ValueMap.Entries set.
(package private) final class	ValueMap.Property	A map entry for a given property.

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

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

Map.Entry<K extends Object,V extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final Object	metadata	The metadata object to wrap.
(package private) final ValueExistencePolicy	valuePolicy	The behavior of this map toward null or empty values.

Fields inherited from class org.apache.sis.metadata.PropertyMap

accessor, entrySet, keyPolicy

Constructor Summary

Constructors

Constructor	Description
ValueMap(Object metadata, PropertyAccessor accessor, KeyNamePolicy keyPolicy, ValueExistencePolicy valuePolicy)	Creates a map of values for the specified metadata and accessor.

Method Summary

Modifier and Type	Method	Description
boolean	containsKey(Object key)	Returns true if this map contains a mapping for the specified key.
Set<Map.Entry<String,Object>>	entrySet()	Returns a view of the mappings contained in this map.
Object	get(Object key)	Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.
boolean	isEmpty()	Returns true if this map contains no key-value mappings.
(package private) final Iterator<Map.Entry<String,Object>>	iterator()	Returns an iterator over the entries contained in this map.
Object	put(String key, Object value)	Associates the specified value with the specified key in this map.
void	putAll(Map<? extends String,?> map)	Puts every entries from the given map.
Object	putIfAbsent(String key, Object value)	Associates the specified value with the specified key in this map if no value is currently associated.
Object	remove(Object key)	Removes the mapping for a key from this map if it is present.
int	size()	Returns the number of elements in this map.

Methods inherited from class java.util.AbstractMap

clear, clone, containsValue, equals, hashCode, keySet, toString, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

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

Field Details

metadata

final Object metadata

The metadata object to wrap.

valuePolicy

final ValueExistencePolicy valuePolicy

The behavior of this map toward null or empty values.

Constructor Details

ValueMap

ValueMap(Object metadata,
 PropertyAccessor accessor,
 KeyNamePolicy keyPolicy,
 ValueExistencePolicy valuePolicy)

Creates a map of values for the specified metadata and accessor.

Parameters:

metadata - the metadata object to wrap.

accessor - the accessor to use for the metadata.

keyPolicy - determines the string representation of keys in the map..

valuePolicy - the behavior of this map toward null or empty values.

Method Details

isEmpty

public boolean isEmpty()

Returns true if this map contains no key-value mappings.

Specified by:

isEmpty in interface Map<String,Object>

Overrides:

isEmpty in class AbstractMap<String,Object>

size

public int size()

Returns the number of elements in this map.

Specified by:

size in interface Map<String,Object>

Overrides:

size in class PropertyMap<Object>

containsKey

public boolean containsKey(Object key)

Returns true if this map contains a mapping for the specified key.

Specified by:

containsKey in interface Map<String,Object>

Overrides:

containsKey in class PropertyMap<Object>

get

public Object get(Object key)

Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.

Specified by:

get in interface Map<String,Object>

Overrides:

get in class AbstractMap<String,Object>

put

public Object put(String key,
 Object value)

Associates the specified value with the specified key in this map.

Specified by:

put in interface Map<String,Object>

Overrides:

put in class AbstractMap<String,Object>

Throws:

IllegalArgumentException - if the given key is not the name of a property in the metadata.

ClassCastException - if the given value is not of the expected type.

UnmodifiableMetadataException - if the property for the given key is read-only.

putIfAbsent

public Object putIfAbsent(String key,
 Object value)

Associates the specified value with the specified key in this map if no value is currently associated.

Throws:

IllegalArgumentException - if the given key is not the name of a property in the metadata.

ClassCastException - if the given value is not of the expected type.

UnmodifiableMetadataException - if the property for the given key is read-only.

putAll

public void putAll(Map<? extends String,?> map)

Puts every entries from the given map. This method is overloaded for performance reasons since we are not interested in the return value of the put(String, Object) method.

Specified by:

putAll in interface Map<String,Object>

Overrides:

putAll in class AbstractMap<String,Object>

Throws:

IllegalArgumentException - if at least one key is not the name of a property in the metadata.

ClassCastException - if at least one value is not of the expected type.

UnmodifiableMetadataException - if at least one property is read-only.

remove

public Object remove(Object key)
              throws UnsupportedOperationException

Removes the mapping for a key from this map if it is present.

Specified by:

remove in interface Map<String,Object>

Overrides:

remove in class AbstractMap<String,Object>

Throws:

UnmodifiableMetadataException - if the property for the given key is read-only.

UnsupportedOperationException

entrySet

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

Returns a view of the mappings contained in this map.

Specified by:

entrySet in interface Map<String,Object>

Overrides:

entrySet in class PropertyMap<Object>

iterator

final Iterator<Map.Entry<String,Object>> iterator()

Returns an iterator over the entries contained in this map.

Specified by:

iterator in class PropertyMap<Object>