Package org.glassfish.hk2.xml.api
Interface XmlHk2ConfigurationBean
- All Known Implementing Classes:
BaseHK2JAXBBean
- Author:
- jwells
-
Method Summary
Modifier and TypeMethodDescriptionReturns a read-only copy of the bean-like map corresponding to the current state of this bean in the default namespace of the documentReturns the instance path/name for this objectReturns the name of the property that returns the key for this bean, or null if this bean does not have a key propertyReturns the key value for this objectGets the model for the given beanReturns the parent of this bean, or null if this object is the root of the true_getProperty(String propName) Gets the property with the given name from the default name space._getProperty(String propNamespace, String propName) Gets the property with the given name._getRoot()Gets the root associated with this bean.Gets the descriptor with which this service was created.Returns the XmlPath for this objectbooleanReturns true if the given property is explicitly set, false if the property has not been explicitly set.booleanReturns true if the given property is explicitly set, false if the property has not been explicitly set_lookupChild(String propName, String keyValue) Looks up the child with the given propertyName that has the given key value._lookupChild(String propNamespace, String propName, String keyValue) Looks up the child with the given propertyName that has the given key valuevoid_setProperty(String propName, Object propValue) Will set the corresponding property of this bean to the given value in the default name space.void_setProperty(String propNamespace, String propName, Object propValue) Will set the corresponding property of this bean to the given value.
-
Method Details
-
_getBeanLikeMap
Returns a read-only copy of the bean-like map corresponding to the current state of this bean in the default namespace of the document- Returns:
- A copy of the bean-like map associated with this bean
-
_getParent
XmlHk2ConfigurationBean _getParent()Returns the parent of this bean, or null if this object is the root of the true- Returns:
- The parent of this object, or null if this is the root of the tree
-
_getXmlPath
String _getXmlPath()Returns the XmlPath for this object- Returns:
- The XmlPath for this object
-
_getInstanceName
String _getInstanceName()Returns the instance path/name for this object- Returns:
- The instance path/name for this object
-
_getKeyPropertyName
QName _getKeyPropertyName()Returns the name of the property that returns the key for this bean, or null if this bean does not have a key property- Returns:
- The name of the key property for this bean or null if this bean does not have a key property
-
_getKeyValue
String _getKeyValue()Returns the key value for this object- Returns:
- The instance path/name for this object
-
_getModel
ModelImpl _getModel()Gets the model for the given bean- Returns:
- The model for the bean
-
_getSelfDescriptor
ActiveDescriptor<?> _getSelfDescriptor()Gets the descriptor with which this service was created. May be null if this service is not advertised in a ServiceLocator- Returns:
- The descriptor with which this service was created or null if this service is not advertised in a ServiceLocator
-
_lookupChild
Looks up the child with the given propertyName that has the given key value. Will only search the default namespace- Parameters:
propName- The non-null property name to look forkeyValue- The non-null keyValue to look for- Returns:
- The child or null if not found
-
_lookupChild
Looks up the child with the given propertyName that has the given key value- Parameters:
propNamespace- The namespace to find the property in. If null then the default namespacepropName- The non-null property name to look forkeyValue- The non-null keyValue to look for- Returns:
- The child or null if not found
-
_isSet
Returns true if the given property is explicitly set, false if the property has not been explicitly set. Will only check the default namespace- Parameters:
propName- The name of the property to check for being set, may not be null- Returns:
- true if the property is explicitly set, false if the property is not explicitly set
-
_isSet
Returns true if the given property is explicitly set, false if the property has not been explicitly set- Parameters:
propNamespace- The namespace to find the property in. If null then the default namespacepropName- The name of the property to check for being set, may not be null- Returns:
- true if the property is explicitly set, false if the property is not explicitly set
-
_getProperty
Gets the property with the given name from the default name space. Defaulting will happen- Parameters:
propName- The property with the given name- Returns:
- The value of this property or the default value if not set
-
_getProperty
Gets the property with the given name. Defaulting will happen- Parameters:
propNamespace- the non-null name space namepropName- The property with the given name- Returns:
- The value of this property or the default value if not set
-
_setProperty
Will set the corresponding property of this bean to the given value in the default name space. Care should be taken that the propName is one of the properties of this bean- Parameters:
propName- The non-null name of a property on this bean to setpropValue- The possibly null value the property should take. May not be null if this property represents some scalar value
-
_setProperty
Will set the corresponding property of this bean to the given value. Care should be taken that the propName is one of the properties of this bean- Parameters:
propNamespace- The non-null name space of this propertypropName- The non-null name of a property on this bean to setpropValue- The possibly null value the property should take. May not be null if this property represents some scalar value
-
_getRoot
XmlRootHandle<?> _getRoot()Gets the root associated with this bean. If this bean has no associated root this will return null- Returns:
- The root of this bean, or null if this bean is not associated with a root
-