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 contraints on its contents. (i.e. an arbitrary map)

See Also:

Serialized Form

Constructor Summary

protected	PropertyDefinitionMap()
	PropertyDefinitionMap(String name, String description, boolean required, PropertyDefinition... properties)

Method Summary

PropertyDefinition	get(String name)
PropertyDefinitionList	getPropertyDefinitionList(String name)
PropertyDefinitionMap	getPropertyDefinitionMap(String name)
Map<String,PropertyDefinition>	getPropertyDefinitions()
PropertyDefinitionSimple	getPropertyDefinitionSimple(String name)
List<PropertyDefinition>	getSummaryPropertyDefinitions() Helper to get only the summary properties for this map definition.
void	put(PropertyDefinition propertyDefinition)
void	setPropertyDefinitions(Map<String,PropertyDefinition> propertyDefinitions)

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PropertyDefinitionMap

public PropertyDefinitionMap(@NotNull
                             String name,
                             String description,
                             boolean required,
                             PropertyDefinition... properties)

PropertyDefinitionMap

protected PropertyDefinitionMap()

Method Detail

getPropertyDefinitions

@NotNull
public Map<String,PropertyDefinition> getPropertyDefinitions()

setPropertyDefinitions

public void setPropertyDefinitions(@NotNull
                                   Map<String,PropertyDefinition> propertyDefinitions)

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)