org.jvnet.hk2.config.types
Interface PropertyBag


public interface PropertyBag

Base interface for those configuration objects that has nested <property> elements.

Author:
Kohsuke Kawaguchi

Nested Class Summary
static class PropertyBag.Duck
           
 
Method Summary
 List<Property> getProperty()
          Gets the value of the property property.
 Property getProperty(String name)
           
 String getPropertyValue(String name)
          Returns a property value if the bean has properties and one of its properties name is equal to the one passed.
 String getPropertyValue(String name, String defaultValue)
          Returns a property value if the bean has properties and one of its properties name is equal to the one passed.
 

Method Detail

getProperty

List<Property> getProperty()
Gets the value of the property 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 property property.

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

    getProperty().add(newItem);
 

Objects of the following type(s) are allowed in the list Property

Returns:
the property list

getProperty

@DuckTyped
Property getProperty(String name)

getPropertyValue

@DuckTyped
String getPropertyValue(String name)
Returns a property value if the bean has properties and one of its properties name is equal to the one passed.

Parameters:
name - the property name requested
Returns:
the property value or null if not found

getPropertyValue

@DuckTyped
String getPropertyValue(String name,
                                  String defaultValue)
Returns a property value if the bean has properties and one of its properties name is equal to the one passed. Otherwise return the default value.

Parameters:
name - the property name requested
defaultValue - is the default value to return in case the property of that name does not exist in this bag
Returns:
the property value


Copyright © 2013 Oracle Corporation. All Rights Reserved.