|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AttributeContext
Encapsulation of the current state of execution.
Method Summary | |
---|---|
void |
addAll(java.util.Map<java.lang.String,Attribute> newAttributes)
Add all attributes to the context. |
void |
addMissing(java.util.Map<java.lang.String,Attribute> defaultAttributes)
Add all attributes to the context. |
void |
clear()
Clear the attributes. |
Attribute |
getAttribute(java.lang.String name)
Retrieve the named attribute, either cascaded or not. |
java.util.Iterator<java.lang.String> |
getAttributeNames()
Deprecated. Use getLocalAttributeNames() or
getCascadedAttributeNames() . |
Attribute |
getCascadedAttribute(java.lang.String name)
Retrieve the attribute that has been cascaded at upper levels. |
java.util.Set<java.lang.String> |
getCascadedAttributeNames()
Returns the names of the cascaded attributes. |
Attribute |
getLocalAttribute(java.lang.String name)
Retrieve the attribute that has been defined in this context (i.e. not cascaded). |
java.util.Set<java.lang.String> |
getLocalAttributeNames()
Returns the names of the local attributes, i.e. the one that have not been cascaded. |
java.lang.String |
getPreparer()
Get associated preparer instance. |
java.lang.String |
getRole()
Access method for the role property. |
java.util.Set<java.lang.String> |
getRoles()
Returns the roles that can render this attribute. |
java.lang.String |
getTemplate()
Access method for the template property. |
void |
inherit(AttributeContext parent)
Copies all missing attributes from the parent attribute
context to this one. |
void |
inheritCascadedAttributes(AttributeContext parent)
Copies the cascaded attributes to this attribute context. |
void |
putAttribute(java.lang.String name,
Attribute value)
Add the specified attribute. |
void |
putAttribute(java.lang.String name,
Attribute value,
boolean cascade)
Add the specified attribute. |
void |
setPreparer(java.lang.String url)
Set associated preparer instance. |
void |
setRole(java.lang.String role)
Sets the value of the role property. |
void |
setRoles(java.util.Set<java.lang.String> roles)
Sets the roles that can render this attribute. |
void |
setTemplate(java.lang.String template)
Sets the value of the template property. |
Method Detail |
---|
java.lang.String getTemplate()
void setTemplate(java.lang.String template)
template
- the new value of the path propertyjava.lang.String getRole()
java.util.Set<java.lang.String> getRoles()
void setRole(java.lang.String role)
role
- the new value of the role propertyvoid setRoles(java.util.Set<java.lang.String> roles)
roles
- The enabled roles.java.lang.String getPreparer()
void setPreparer(java.lang.String url)
url
- The preparer name.void addAll(java.util.Map<java.lang.String,Attribute> newAttributes)
newAttributes
- the attributes to be added.void addMissing(java.util.Map<java.lang.String,Attribute> defaultAttributes)
defaultAttributes
- attributes which should be present.void inheritCascadedAttributes(AttributeContext parent)
parent
- The parent context to be used.void inherit(AttributeContext parent)
parent
attribute
context to this one.
parent
- The attribute context to copy attributes from.Attribute getAttribute(java.lang.String name)
name
- key name for the attribute.
Attribute getLocalAttribute(java.lang.String name)
name
- key name for the attribute.
null
otherwise.Attribute getCascadedAttribute(java.lang.String name)
name
- key name for the attribute.
null
otherwise.@Deprecated java.util.Iterator<java.lang.String> getAttributeNames()
getLocalAttributeNames()
or
getCascadedAttributeNames()
.
java.util.Set<java.lang.String> getLocalAttributeNames()
java.util.Set<java.lang.String> getCascadedAttributeNames()
void putAttribute(java.lang.String name, Attribute value)
putAttribute(String, Attribute, boolean)
with
cascade = false
.
name
- name of the attributevalue
- value of the attributevoid putAttribute(java.lang.String name, Attribute value, boolean cascade)
name
- name of the attributevalue
- value of the attributecascade
- If true
, the attribute value will be
available in all nested contexts. If false
, it will be
available only in the current context.void clear()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |