org.rhq.core.domain.configuration.definition
Class PropertyDefinitionMap
java.lang.Object
org.rhq.core.domain.configuration.definition.PropertyDefinition
org.rhq.core.domain.configuration.definition.PropertyDefinitionMap
- All Implemented Interfaces:
- Serializable
public class PropertyDefinitionMap
- extends PropertyDefinition
The definition of properties in a map. The map may be null allowing for the requirement of the map's existence but no
constraints on its contents. (i.e. an arbitrary map)
- See Also:
- Serialized Form
| Methods inherited from class org.rhq.core.domain.configuration.definition.PropertyDefinition |
getActivationPolicy, getConfigurationDefinition, getDescription, getDisplayName, getId, getName, getOrder, getParentPropertyListDefinition, getParentPropertyMapDefinition, getPropertyGroupDefinition, getVersion, isReadOnly, isRequired, isSummary, setActivationPolicy, setConfigurationDefinition, setDescription, setDisplayName, setId, setName, setOrder, setParentPropertyListDefinition, setParentPropertyMapDefinition, setPropertyGroupDefinition, setReadOnly, setRequired, setSummary, setVersion, toString |
PropertyDefinitionMap
public PropertyDefinitionMap(@NotNull
String name,
String description,
boolean required,
PropertyDefinition... properties)
PropertyDefinitionMap
protected PropertyDefinitionMap()
getMap
@NotNull
public Map<String,PropertyDefinition> getMap()
- Returns:
- The Mapping. This guarantees no ordering.
setMap
public void setMap(@NotNull
Map<String,PropertyDefinition> map)
getPropertyDefinitions
public List<PropertyDefinition> getPropertyDefinitions()
- Convenience routine to get the ordered properties from the Map.
- Returns:
- Not Null. The map's property definitions sorted by PropertyDefinition.order, ascending. Min(order) is 0.
getSummaryPropertyDefinitions
@NotNull
public List<PropertyDefinition> getSummaryPropertyDefinitions()
- Helper to get only the summary properties for this map definition. If no properties were defined as summary
properties in the plugin descriptor, the full list of properties will be returned.
- Returns:
- the member properties that are marked as summary properties; the properties will be returned in the same
order they were defined in the plugin descriptor; if no properties were defined as summary properties in
the plugin descriptor, the full list of properties will be returned
getPropertyDefinitionSimple
public PropertyDefinitionSimple getPropertyDefinitionSimple(String name)
getPropertyDefinitionList
public PropertyDefinitionList getPropertyDefinitionList(String name)
getPropertyDefinitionMap
public PropertyDefinitionMap getPropertyDefinitionMap(String name)
get
public PropertyDefinition get(String name)
put
public void put(PropertyDefinition propertyDefinition)
- If an order index is not set on the propertyDefinition it will be set to the current number
of propDefs for the map. So, adding props to the map in the desired order will
the
- Parameters:
propertyDefinition -
Copyright © 2008-2012 Red Hat, Inc.. All Rights Reserved.