public interface ManagedProperty extends Serializable, TransientAttachments
ManagedDeployment
, ManagedObject
, or ManagedComponent
. The
property's name is a String and its value is a MetaValue
. A property also has additional metadata associated
with it, such as constraints on its value, a mandatory flag, a read-only flag, etc.Modifier and Type | Method and Description |
---|---|
String |
checkValidValue(MetaValue value)
Check whether this is a valid value
|
ManagedProperty |
copy()
Create a copy of the managed property.
|
ActivationPolicy |
getActivationPolicy()
Get the activation policy for property value updates.
|
Collection<String> |
getAdminViewUses()
Return the admin view names associated with the property
|
Map<String,Annotation> |
getAnnotations()
Get the annotations associated with the property
NOTE: Clients should not use this method - it is intended for server-side use only.
|
MetaValue |
getDefaultValue()
Get the property default value if one exists.
|
String |
getDescription()
Get the description
|
<T> T |
getField(String fieldName,
Class<T> expected)
Get a field
|
Fields |
getFields()
Get the fields
|
Set<MetaValue> |
getLegalValues()
Get the legal values
|
ManagedObject |
getManagedObject()
Get the managed object the property is associated with.
|
String |
getMappedName()
Get the property's mapped name.
|
Comparable<? extends MetaValue> |
getMaximumValue()
Get the maximum value
|
MetaType |
getMetaType()
Get the type
|
Comparable<? extends MetaValue> |
getMinimumValue()
Get the minimum value
|
String |
getName()
Get the property's name
|
ManagedObject |
getTargetManagedObject()
Get the target ManagedObject.
|
MetaValue |
getValue()
Get the value
|
boolean |
hasAnnotation(String key)
Does the property have the annotation referenced by key.
|
boolean |
hasViewUse(ViewUse use)
See if the property has the indicated ViewUse among its
|
boolean |
isMandatory()
Whether the property is mandatory
|
boolean |
isModified()
Whether the property has been edited/modified.
|
boolean |
isReadOnly()
Whether the property is read only
|
boolean |
isRemoved()
Whether the property has been marked as removed from its ManagedObject.
|
void |
setField(String fieldName,
Serializable value)
Set a field
|
void |
setManagedObject(ManagedObject managedObject)
Set the managed object the property is associated with.
|
void |
setModified(boolean flag)
Set the modified state of the property value.
|
void |
setRemoved(boolean flag)
Set whether a property has been marked as removed from its ManagedObject.
|
void |
setTargetManagedObject(ManagedObject target)
Set the target ManagedObject.
|
void |
setValue(MetaValue value)
Set the value
|
getTransientAttachment, getTransientAttachment, setTransientAttachment
ManagedObject getManagedObject()
void setManagedObject(ManagedObject managedObject)
managedObject
- the managed objectManagedObject getTargetManagedObject()
ManagementObjectRef}
void setTargetManagedObject(ManagedObject target)
target
- the target ManagedObjectFields getFields()
ManagedProperty copy()
<T> T getField(String fieldName, Class<T> expected)
T
- the expected typefieldName
- the field nameexpected
- the expected typevoid setField(String fieldName, Serializable value)
fieldName
- the field namevalue
- the valueString getName()
String getMappedName()
String getDescription()
MetaType getMetaType()
Map<String,Annotation> getAnnotations()
boolean hasAnnotation(String key)
key
- the key into getAnnotations()
boolean hasViewUse(ViewUse use)
use
- - the ViewUse to check forCollection<String> getAdminViewUses()
ActivationPolicy getActivationPolicy()
MetaValue getValue()
void setValue(MetaValue value)
value
- the valueMetaValue getDefaultValue()
Comparable<? extends MetaValue> getMinimumValue()
Comparable<? extends MetaValue> getMaximumValue()
String checkValidValue(MetaValue value)
value
- the valueboolean isMandatory()
boolean isReadOnly()
boolean isModified()
void setModified(boolean flag)
flag
- - whether the property has been modifiedboolean isRemoved()
void setRemoved(boolean flag)
flag
- - true is the property has been removed, false if not.Copyright © 2013 JBoss, a division of Red Hat, Inc.. All Rights Reserved.