org.rhq.core.clientapi.descriptor.configuration
Class MapProperty

java.lang.Object
  extended by org.rhq.core.clientapi.descriptor.configuration.ConfigurationProperty
      extended by org.rhq.core.clientapi.descriptor.configuration.MapProperty

public class MapProperty
extends ConfigurationProperty

The definition of a child map of properties.

Java class for mapProperty complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="mapProperty">
   <complexContent>
     <extension base="{urn:xmlns:rhq-configuration}configurationProperty">
       <sequence>
         <element ref="{urn:xmlns:rhq-configuration}configuration-property" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 


Field Summary
protected  java.util.List<javax.xml.bind.JAXBElement<? extends ConfigurationProperty>> configurationProperty
           
 
Fields inherited from class org.rhq.core.clientapi.descriptor.configuration.ConfigurationProperty
description, displayName, longDescription, name, readOnly, required, summary
 
Constructor Summary
MapProperty()
           
 
Method Summary
 java.util.List<javax.xml.bind.JAXBElement<? extends ConfigurationProperty>> getConfigurationProperty()
          The map of child property definitions.
 
Methods inherited from class org.rhq.core.clientapi.descriptor.configuration.ConfigurationProperty
getDescription, getDisplayName, getLongDescription, getName, isReadOnly, isRequired, isSummary, setDescription, setDisplayName, setLongDescription, setName, setReadOnly, setRequired, setSummary
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

configurationProperty

protected java.util.List<javax.xml.bind.JAXBElement<? extends ConfigurationProperty>> configurationProperty
Constructor Detail

MapProperty

public MapProperty()
Method Detail

getConfigurationProperty

public java.util.List<javax.xml.bind.JAXBElement<? extends ConfigurationProperty>> getConfigurationProperty()
The map of child property definitions. If not supplied, the map can contain artitrary child properties. Gets the value of the configurationProperty property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the configurationProperty property.

For example, to add a new item, do as follows:

    getConfigurationProperty().add(newItem);
 

Objects of the following type(s) are allowed in the list JAXBElement<ListProperty> JAXBElement<MapProperty> JAXBElement<ConfigurationProperty> JAXBElement<SimpleProperty>



Copyright © 2008-2009 Red Hat, Inc.. All Rights Reserved.