org.apache.sling.jcr.resource

Class JcrPropertyMap

java.lang.Object

org.apache.sling.jcr.resource.JcrPropertyMap

All Implemented Interfaces:

Map<String,Object>, ValueMap

Direct Known Subclasses:

JcrModifiablePropertyMap

public class JcrPropertyMap
extends Object
implements ValueMap

An implementation of the value map based on a JCR node.

See Also:

JcrModifiablePropertyMap

Nested Class Summary

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

Map.Entry<K,V>

Field Summary

Fields inherited from interface org.apache.sling.api.resource.ValueMap

EMPTY

Constructor Summary

Constructors

Constructor and Description
JcrPropertyMap(javax.jcr.Node node) Constructor
JcrPropertyMap(javax.jcr.Node node, ClassLoader dynamicCL) Constructor

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<Map.Entry<String,Object>>	entrySet()
protected String	escapeKeyName(String key) Handles key name escaping by taking into consideration if it contains a registered prefix
Object	get(Object aKey)
<T> T	get(String aKey, Class<T> type) Get a named property and convert it into the given type.
<T> T	get(String aKey, T defaultValue) Get a named property and convert it into the given type.
String	getPath() Deprecated.
boolean	isEmpty()
Set<String>	keySet()
Object	put(String key, Object value)
void	putAll(Map<? extends String,? extends Object> t)
Object	remove(Object key)
int	size()
String	toString()
Collection<Object>	values()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

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

Constructor Detail

JcrPropertyMap

public JcrPropertyMap(javax.jcr.Node node)

Constructor

Parameters:

node - The underlying node.

JcrPropertyMap

public JcrPropertyMap(javax.jcr.Node node,
                      ClassLoader dynamicCL)

Constructor

Parameters:

node - The underlying node.

dynamicCL - Dynamic class loader for loading serialized objects.

Since:

2.0.8

Method Detail

get

public <T> T get(String aKey,
                 Class<T> type)

Description copied from interface: ValueMap

Get a named property and convert it into the given type. This method does not support conversion into a primitive type or an array of a primitive type. It should return null in this case.

Specified by:

get in interface ValueMap

Parameters:

aKey - The name of the property

type - The class of the type

Returns:

Return named value converted to type T or null if non existing or can't be converted.

See Also:

ValueMap.get(java.lang.String, java.lang.Class)

get

public <T> T get(String aKey,
                 T defaultValue)

Description copied from interface: ValueMap

Get a named property and convert it into the given type. This method does not support conversion into a primitive type or an array of a primitive type. It should return the default value in this case.

Specified by:

get in interface ValueMap

Parameters:

aKey - The name of the property

defaultValue - The default value to use if the named property does not exist or cannot be converted to the requested type. The default value is also used to define the type to convert the value to. If this is null any existing property is not converted.

Returns:

Return named value converted to type T or the default value if non existing or can't be converted.

See Also:

ValueMap.get(java.lang.String, java.lang.Object)

get

public Object get(Object aKey)

Specified by:

get in interface Map<String,Object>

See Also:

Map.get(java.lang.Object)

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<String,Object>

See Also:

Map.containsKey(java.lang.Object)

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<String,Object>

See Also:

Map.containsValue(java.lang.Object)

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<String,Object>

See Also:

Map.isEmpty()

size

public int size()

Specified by:

size in interface Map<String,Object>

See Also:

Map.size()

entrySet

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

Specified by:

entrySet in interface Map<String,Object>

See Also:

Map.entrySet()

keySet

public Set<String> keySet()

Specified by:

keySet in interface Map<String,Object>

See Also:

Map.keySet()

values

public Collection<Object> values()

Specified by:

values in interface Map<String,Object>

See Also:

Map.values()

getPath

@Deprecated
public String getPath()

Deprecated.

Return the path of the current node.

Throws:

IllegalStateException - If a repository exception occurs

escapeKeyName

protected String escapeKeyName(String key)
                        throws javax.jcr.RepositoryException

Handles key name escaping by taking into consideration if it contains a registered prefix

Parameters:

key -

Returns:

escaped key name

Throws:

javax.jcr.RepositoryException

clear

public void clear()

Specified by:

clear in interface Map<String,Object>

put

public Object put(String key,
                  Object value)

Specified by:

put in interface Map<String,Object>

putAll

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

Specified by:

putAll in interface Map<String,Object>

remove

public Object remove(Object key)

Specified by:

remove in interface Map<String,Object>

toString

public String toString()

Overrides:

toString in class Object