Package org.apache.sis.metadata

Class PropertyMap<V>

java.lang.Object

java.util.AbstractMap<String,V>

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

Type Parameters:

V - the type of values in the map.

All Implemented Interfaces:

Map<String,V>

Direct Known Subclasses:

IndexMap, InformationMap, NameMap, TypeMap, ValueMap

abstract class PropertyMap<V>
extends AbstractMap<String,V>

The base class of Map views of metadata properties. The map keys are fixed to the String type and will be the property names. The map values depend on the actual PropertyMap subclasses; they may be property values, property classes or property information.

Since:

0.3

Version:

0.3

See Also:

• ValueMap
• NameMap
• TypeMap
• InformationMap

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) class	PropertyMap.Entries	Base class of views of the entries contained in the map.
(package private) class	PropertyMap.Iter	The iterator over the elements contained in a PropertyMap<V>.Entries set.

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 PropertyAccessor	accessor	The accessor to use for accessing the property names, types or values.
(package private) Set<Map.Entry<String,V>>	entrySet	A view of the mappings contained in this map.
(package private) final KeyNamePolicy	keyPolicy	Determines the string representation of keys in the map.

Constructor Summary

Constructors

Constructor	Description
PropertyMap(PropertyAccessor accessor, KeyNamePolicy keyPolicy)	Creates a new map backed by the given 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,V>>	entrySet()	Returns a view of the mappings contained in this map.
(package private) abstract Iterator<Map.Entry<String,V>>	iterator()	Returns an iterator over the entries in this map.
int	size()	Returns the number of elements in this map.

Methods inherited from class java.util.AbstractMap

clear, clone, containsValue, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, 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, putIfAbsent, remove, replace, replace, replaceAll

Field Details

accessor

final PropertyAccessor accessor

The accessor to use for accessing the property names, types or values.

keyPolicy

final KeyNamePolicy keyPolicy

Determines the string representation of keys in the map.

entrySet

transient Set<Map.Entry<String,V>> entrySet

A view of the mappings contained in this map.

Constructor Details

PropertyMap

PropertyMap(PropertyAccessor accessor,
 KeyNamePolicy keyPolicy)

Creates a new map backed by the given accessor.

Method Details

size

public int size()

Returns the number of elements in this map. The default implementation returns PropertyAccessor.count(), which is okay only if all metadata defined by the standard are included in the map. Subclasses shall override this method if their map contain only a subset of all possible metadata elements.

Specified by:

size in interface Map<String,V>

Overrides:

size in class AbstractMap<String,V>

containsKey

public boolean containsKey(Object key)

Returns true if this map contains a mapping for the specified key. The default implementation is okay only if all metadata defined by the standard are included in the map. Subclasses shall override this method if their map contain only a subset of all possible metadata elements.

Specified by:

containsKey in interface Map<String,V>

Overrides:

containsKey in class AbstractMap<String,V>

entrySet

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

Returns a view of the mappings contained in this map. Subclasses shall override this method if they define a different entries set class than the default PropertyMap<V>.Entries inner class.

Specified by:

entrySet in interface Map<String,V>

Specified by:

entrySet in class AbstractMap<String,V>

iterator

abstract Iterator<Map.Entry<String,V>> iterator()

Returns an iterator over the entries in this map.