Package com.composum.sling.core

Class InheritedValues

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,Object>

com.composum.sling.core.InheritedValues

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>, org.apache.sling.api.resource.ValueMap

public class InheritedValues
extends HashMap<String,Object>
implements org.apache.sling.api.resource.ValueMap

The value map which extends the property retrieval to the context (parents,...) of a resource.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InheritedValues.HierarchyScanResult
static class	InheritedValues.Type	the various types of inheritance contentRelated Each node at the same position relative to the 'jcr:content' nodes is checked for an inherited value.

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
protected org.apache.sling.api.resource.Resource	entryPoint
protected org.apache.sling.api.resource.Resource	exitPoint
protected InheritedValues.Type	inheritanceType
protected String	relativePath
protected org.apache.sling.api.resource.Resource	resource
static Object	UNDEFINED

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

EMPTY

Constructor Summary

Constructors

Constructor	Description
InheritedValues(org.apache.sling.api.resource.Resource resource)
InheritedValues(org.apache.sling.api.resource.Resource resource, boolean nodeInheritance)	Deprecated.
InheritedValues(org.apache.sling.api.resource.Resource resource, boolean nodeInheritance, boolean restrictToSameContent)	Deprecated.
InheritedValues(org.apache.sling.api.resource.Resource resource, InheritedValues.Type inheritanceType)

Method Summary

Modifier and Type	Method	Description
protected void	findEntryPoint()	Retrieves the first parent node for inheritance traversal (that is, the node above jcr:content) and defines the relativePath of the property wrt.
protected <T> T	findInherited(String name, Class<T> type)
InheritedValues.HierarchyScanResult	findOriginAndValue(String name, Class<?> type)	Searches the value along the repositories hierarchy by the entry point and path determined before.
<T> T	get(@NotNull String name, @NotNull Class<T> type)	Gets an inherited value.
<T> T	get(@NotNull String name, T defaultValue)	Gets an inherited value.
protected String	getRelativePath(String name)

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Field Detail

UNDEFINED

public static final Object UNDEFINED

resource

protected final org.apache.sling.api.resource.Resource resource

inheritanceType

protected final InheritedValues.Type inheritanceType

exitPoint

protected transient org.apache.sling.api.resource.Resource exitPoint

entryPoint

protected transient org.apache.sling.api.resource.Resource entryPoint

relativePath

protected transient String relativePath

Constructor Detail

InheritedValues

public InheritedValues(org.apache.sling.api.resource.Resource resource)

InheritedValues

public InheritedValues(org.apache.sling.api.resource.Resource resource,
                       InheritedValues.Type inheritanceType)

InheritedValues

@Deprecated
public InheritedValues(org.apache.sling.api.resource.Resource resource,
                       boolean nodeInheritance)

Deprecated.

InheritedValues

@Deprecated
public InheritedValues(org.apache.sling.api.resource.Resource resource,
                       boolean nodeInheritance,
                       boolean restrictToSameContent)

Deprecated.

Method Detail

get

@Nullable
public <T> T get(@NotNull
                 @NotNull String name,
                 @NotNull
                 @NotNull Class<T> type)

Gets an inherited value.

Specified by:

get in interface org.apache.sling.api.resource.ValueMap

Type Parameters:

T - the expected type of the value

Parameters:

name - the property name or path

Returns:

inherited value if existing or null

get

@NotNull
public <T> T get(@NotNull
                 @NotNull String name,
                 @NotNull
                 T defaultValue)

Gets an inherited value.

Specified by:

get in interface org.apache.sling.api.resource.ValueMap

Type Parameters:

T - the expected type of the value

Parameters:

name - the property name or path

defaultValue - the default value, must not be null

Returns:

inherited value if existing, otherwise the default value

findInherited

protected <T> T findInherited(String name,
                              Class<T> type)

findOriginAndValue

public InheritedValues.HierarchyScanResult findOriginAndValue(String name,
                                                              Class<?> type)

Searches the value along the repositories hierarchy by the entry point and path determined before.

Parameters:

name - the property name or path

type - the expected type of the value

Returns:

the value found or null if no such value found in one of the appropriate parent nodes

getRelativePath

protected String getRelativePath(String name)

findEntryPoint

protected void findEntryPoint()

Retrieves the first parent node for inheritance traversal (that is, the node above jcr:content) and defines the relativePath of the property wrt. this node.