Package com.day.cq.wcm.commons.policy

Class ContentPolicyStyle

java.lang.Object

com.day.cq.wcm.commons.policy.ContentPolicyStyle

All Implemented Interfaces:

Style, Map<String,Object>, ValueMap

public class ContentPolicyStyle
extends Object
implements Style

A compatibility wrapper using a content policy as a style. The goal is to use components using the currentStyle binding with the new content policies, without the need to change the component. This will not be a complete style implementation but rather focuses on the reading of the map values.

Since:

6.1

Nested Class Summary

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

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

Field Summary

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

EMPTY

Constructor Summary

Constructors

Constructor	Description
ContentPolicyStyle(ContentPolicy contentPolicy, Cell cell)

Method Summary

Modifier and Type	Method	Description
void	clear()
boolean	containsKey(Object o)
boolean	containsValue(Object o)
Set<Map.Entry<String,Object>>	entrySet()
Object	get(Object o)
<T> T	get(String name, Class<T> type)	Return named value converted to type T or null if not existing.
<T> T	get(String name, T defaultValue)	return named value converted to the type T of the default value or the default value if the named value does not exist
Cell	getCell()	Returns the cell of this style
String	getDefiningPath(String name)	Returns the cell path that defines the style property with the given name.
Resource	getDefiningResource(String name)	Returns the resource that defines the style property with the given name.
Design	getDesign()	Returns the design this style is defined in.
String	getPath()	Returns the path to this cell resource
Style	getSubStyle(String relPath)	Returns a sub style for the give one, by virtually extending the cell stack.
boolean	isEmpty()
Set<String>	keySet()
Object	put(String s, Object o)
void	putAll(Map<? extends String,?> map)
Object	remove(Object o)
int	size()
Collection<Object>	values()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, 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

ContentPolicyStyle

public ContentPolicyStyle(ContentPolicy contentPolicy,
                          Cell cell)

Method Detail

getDesign

public Design getDesign()

Description copied from interface: Style

Returns the design this style is defined in.

Specified by:

getDesign in interface Style

Returns:

the design.

getPath

public String getPath()

Description copied from interface: Style

Returns the path to this cell resource

Specified by:

getPath in interface Style

Returns:

the path

getCell

public Cell getCell()

Description copied from interface: Style

Returns the cell of this style

Specified by:

getCell in interface Style

Returns:

the cell

get

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

Description copied from interface: Style

Return named value converted to type T or null if not existing. Please note that this also supports a Resource class as type in order to retrieve a style resource (e.g. image)

Specified by:

get in interface Style

Specified by:

get in interface ValueMap

Type Parameters:

T - The class of the type

Parameters:

name - the name of the property or resource

type - The class of the type

Returns:

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

get

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

Description copied from interface: Style

return named value converted to the type T of the default value or the default value if the named value does not exist

Specified by:

get in interface Style

Specified by:

get in interface ValueMap

Type Parameters:

T - The expected type

Parameters:

name - the name of the property

defaultValue - the default value

Returns:

the value.

getDefiningResource

public Resource getDefiningResource(String name)

Description copied from interface: Style

Returns the resource that defines the style property with the given name.

Specified by:

getDefiningResource in interface Style

Parameters:

name - name of the style property

Returns:

resource or null

getDefiningPath

public String getDefiningPath(String name)

Description copied from interface: Style

Returns the cell path that defines the style property with the given name.

Specified by:

getDefiningPath in interface Style

Parameters:

name - name of the style property

Returns:

path or null

getSubStyle

public Style getSubStyle(String relPath)

Description copied from interface: Style

Returns a sub style for the give one, by virtually extending the cell stack.

Specified by:

getSubStyle in interface Style

Parameters:

relPath - relative path of the sub style.

Returns:

the new style

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 o)

Specified by:

containsKey in interface Map<String,Object>

containsValue

public boolean containsValue(Object o)

Specified by:

containsValue in interface Map<String,Object>

get

public Object get(Object o)

Specified by:

get in interface Map<String,Object>

put

public Object put(String s,
                  Object o)

Specified by:

put in interface Map<String,Object>

remove

public Object remove(Object o)

Specified by:

remove in interface Map<String,Object>

putAll

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

Specified by:

putAll in interface Map<String,Object>

clear

public void clear()

Specified by:

clear in interface Map<String,Object>

keySet

public Set<String> keySet()

Specified by:

keySet in interface Map<String,Object>

values

public Collection<Object> values()

Specified by:

values in interface Map<String,Object>

entrySet

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

Specified by:

entrySet in interface Map<String,Object>