com.day.cq.wcm.commons.policy

Class ContentPolicyStyle

java.lang.Object

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

All Implemented Interfaces:

com.day.cq.wcm.api.designer.Style, java.util.Map<java.lang.String,java.lang.Object>, ValueMap

public class ContentPolicyStyle
extends java.lang.Object
implements com.day.cq.wcm.api.designer.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

java.util.Map.Entry<K,V>

Field Summary

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

EMPTY

Constructor Summary

Constructors

Constructor and Description
ContentPolicyStyle(com.day.cq.wcm.api.policies.ContentPolicy contentPolicy, com.day.cq.wcm.api.designer.Cell cell)

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(java.lang.Object o)
boolean	containsValue(java.lang.Object o)
java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>>	entrySet()
java.lang.Object	get(java.lang.Object o)
<T> T	get(java.lang.String name, java.lang.Class<T> type) Get a named property and convert it into the given type.
<T> T	get(java.lang.String name, T defaultValue) Get a named property and convert it into the given type.
com.day.cq.wcm.api.designer.Cell	getCell()
java.lang.String	getDefiningPath(java.lang.String name)
Resource	getDefiningResource(java.lang.String name)
com.day.cq.wcm.api.designer.Design	getDesign()
java.lang.String	getPath()
com.day.cq.wcm.api.designer.Style	getSubStyle(java.lang.String relPath)
boolean	isEmpty()
java.util.Set<java.lang.String>	keySet()
java.lang.Object	put(java.lang.String s, java.lang.Object o)
void	putAll(java.util.Map<? extends java.lang.String,?> map)
java.lang.Object	remove(java.lang.Object o)
int	size()
java.util.Collection<java.lang.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(com.day.cq.wcm.api.policies.ContentPolicy contentPolicy,
                          com.day.cq.wcm.api.designer.Cell cell)

Method Detail

getDesign

public com.day.cq.wcm.api.designer.Design getDesign()

Specified by:

getDesign in interface com.day.cq.wcm.api.designer.Style

getPath

public java.lang.String getPath()

Specified by:

getPath in interface com.day.cq.wcm.api.designer.Style

getCell

public com.day.cq.wcm.api.designer.Cell getCell()

Specified by:

getCell in interface com.day.cq.wcm.api.designer.Style

get

public <T> T get(java.lang.String name,
                 java.lang.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 com.day.cq.wcm.api.designer.Style

Specified by:

get in interface ValueMap

Type Parameters:

T - The class of the type

Parameters:

name - 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.

get

public <T> T get(java.lang.String name,
                 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.

Implementation hint: In the past it was allowed to call this with a 2nd parameter being null. Therefore all implementations should internally call Map.get(Object) when the 2nd parameter has value null.

Specified by:

get in interface com.day.cq.wcm.api.designer.Style

Specified by:

get in interface ValueMap

Type Parameters:

T - The expected type

Parameters:

name - 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. Must not be null. If you want to return null by default rather rely on ValueMap.get(String, Class).

Returns:

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

getDefiningResource

public Resource getDefiningResource(java.lang.String name)

Specified by:

getDefiningResource in interface com.day.cq.wcm.api.designer.Style

getDefiningPath

public java.lang.String getDefiningPath(java.lang.String name)

Specified by:

getDefiningPath in interface com.day.cq.wcm.api.designer.Style

getSubStyle

public com.day.cq.wcm.api.designer.Style getSubStyle(java.lang.String relPath)

Specified by:

getSubStyle in interface com.day.cq.wcm.api.designer.Style

size

public int size()

Specified by:

size in interface java.util.Map<java.lang.String,java.lang.Object>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map<java.lang.String,java.lang.Object>

containsKey

public boolean containsKey(java.lang.Object o)

Specified by:

containsKey in interface java.util.Map<java.lang.String,java.lang.Object>

containsValue

public boolean containsValue(java.lang.Object o)

Specified by:

containsValue in interface java.util.Map<java.lang.String,java.lang.Object>

get

public java.lang.Object get(java.lang.Object o)

Specified by:

get in interface java.util.Map<java.lang.String,java.lang.Object>

put

public java.lang.Object put(java.lang.String s,
                            java.lang.Object o)

Specified by:

put in interface java.util.Map<java.lang.String,java.lang.Object>

remove

public java.lang.Object remove(java.lang.Object o)

Specified by:

remove in interface java.util.Map<java.lang.String,java.lang.Object>

putAll

public void putAll(java.util.Map<? extends java.lang.String,?> map)

Specified by:

putAll in interface java.util.Map<java.lang.String,java.lang.Object>

clear

public void clear()

Specified by:

clear in interface java.util.Map<java.lang.String,java.lang.Object>

keySet

public java.util.Set<java.lang.String> keySet()

Specified by:

keySet in interface java.util.Map<java.lang.String,java.lang.Object>

values

public java.util.Collection<java.lang.Object> values()

Specified by:

values in interface java.util.Map<java.lang.String,java.lang.Object>

entrySet

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

Specified by:

entrySet in interface java.util.Map<java.lang.String,java.lang.Object>