XmlRootHandleImpl (HK2 XML Reader using JAXB 2.5.0-b05 API)

java.lang.Object
- org.glassfish.hk2.xml.internal.XmlRootHandleImpl<T>

All Implemented Interfaces:: XmlRootHandle<T>

public class XmlRootHandleImpl<T>
extends Object
implements XmlRootHandle<T>

Author:: jwells

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addRoot()` This method can be used if the root of the tree has no required fields, and is the combination of `XmlService.createBean(Class)` and `XmlRootHandle.addRoot(Object)`.
`void`	`addRoot(T newRoot)` If this handle does not already have a root bean this method will add the one given
`T`	`getReadOnlyRoot(boolean representDefaults)` This method returns a read-only copy of the existing tree.
`T`	`getRoot()` Gets the root of the JavaBean tree
`Class<T>`	`getRootClass()` Returns the root interface of this handle
`URI`	`getURI()` Represents the original URI from which this tree was parsed (or null if this tree did not come from a URI)
`XmlRootCopy<T>`	`getXmlRootCopy()` Creates a copy of this tree that is not advertised.
`boolean`	`isAdvertisedInHub()` Returns true if this handles root and children are advertised in the `Hub`
`boolean`	`isAdvertisedInLocator()` Returns true if this handles root and children are advertised in it service locator
`void`	`overlay(XmlRootHandle<T> newRoot)` This method overlays the current root and children with the root and children from newRoot.
`T`	`removeRoot()` If this handle has a root this method will delete it and all children, leaving the root of this tree null
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - getRoot
```
public T getRoot()
```
    Description copied from interface: XmlRootHandle
    
    Gets the root of the JavaBean tree
    
    Specified by:
    
    getRoot in interface XmlRootHandle<T>
    
    Returns:
    The root of the JavaBean tree. Will only return null if the tree has not yet been created
  - getRootClass
```
public Class<T> getRootClass()
```
    Description copied from interface: XmlRootHandle
    
    Returns the root interface of this handle
    
    Specified by:
    
    getRootClass in interface XmlRootHandle<T>
    
    Returns:
    The root class or interface of this handle. Will not return null
  - getURI
```
public URI getURI()
```
    Description copied from interface: XmlRootHandle
    
    Represents the original URI from which this tree was parsed (or null if this tree did not come from a URI)
    
    Specified by:
    
    getURI in interface XmlRootHandle<T>
    
    Returns:
    The original URI from which this tree was parsed, or null if this tree did not come from a URI
  - isAdvertisedInLocator
```
public boolean isAdvertisedInLocator()
```
    Description copied from interface: XmlRootHandle
    
    Returns true if this handles root and children are advertised in it service locator
    
    Specified by:
    
    isAdvertisedInLocator in interface XmlRootHandle<T>
    
    Returns:
    true if the root and children are advertised in the associated service locator
  - isAdvertisedInHub
```
public boolean isAdvertisedInHub()
```
    Description copied from interface: XmlRootHandle
    
    Returns true if this handles root and children are advertised in the Hub
    
    Specified by:
    
    isAdvertisedInHub in interface XmlRootHandle<T>
    
    Returns:
    true if the root and children are advertised in the associated Hub
  - overlay
```
public void overlay(XmlRootHandle<T> newRoot)
```
    Description copied from interface: XmlRootHandle
    
    This method overlays the current root and children with the root and children from newRoot. newRoot must have the same rootClass and must NOT be advertised in either the locator or the hub. The system will calculate the set of changes needed to convert this root into the root from newRoot.
    All nodes that are at the same spot in the tree (have the same xpath and same instance name) will not be modified, but will instead have attributes changed. All nodes present in newRoot but not in this root will be considered adds. All nodes not present in newRoot but in this root will be considered deletes
    The URI will not be modified by this call, nor will the state of advertisement
    
    Specified by:
    
    overlay in interface XmlRootHandle<T>
    
    Parameters:
    newRoot - The non-null root that will be overlayed onto this handle
  - getXmlRootCopy
```
public XmlRootCopy<T> getXmlRootCopy()
```
    Description copied from interface: XmlRootHandle
    
    Creates a copy of this tree that is not advertised. Modifications can be made to this copy and then merged back into the parent in a single transaction
    There is no requirement to call XmlRootCopy.merge() since the parent keeps no track of children. However, the XmlRootCopy.merge() method will fail if a modification has been made to the parent since the time the copy was created
    
    Specified by:
    
    getXmlRootCopy in interface XmlRootHandle<T>
    
    Returns:
    A non-null copy of this root that can be modified and then merged back in a single transaction
  - addRoot
```
public void addRoot(T newRoot)
```
    Description copied from interface: XmlRootHandle
    
    If this handle does not already have a root bean this method will add the one given
    
    Specified by:
    
    addRoot in interface XmlRootHandle<T>
    
    Parameters:
    newRoot - The non-null instance of the root type of this handle
  - addRoot
```
public void addRoot()
```
    Description copied from interface: XmlRootHandle
    
    This method can be used if the root of the tree has no required fields, and is the combination of XmlService.createBean(Class) and XmlRootHandle.addRoot(Object). This method will throw an exception from the validator (if validation is enabled) if the root type has required fields or fails other validation
    
    Specified by:
    
    addRoot in interface XmlRootHandle<T>
  - removeRoot
```
public T removeRoot()
```
    Description copied from interface: XmlRootHandle
    
    If this handle has a root this method will delete it and all children, leaving the root of this tree null
    
    Specified by:
    
    removeRoot in interface XmlRootHandle<T>
    
    Returns:
    The root that was deleted, or null if the root was already null
  - getReadOnlyRoot
```
public T getReadOnlyRoot(boolean representDefaults)
```
    Description copied from interface: XmlRootHandle
    
    This method returns a read-only copy of the existing tree. Any method that would change anything in this tree will fail. Methods that are customized will also fail
    If representsDefaults is true then getters for unset fields will return the default value. If representsDefaults is false then getters for unset fields will return null (or 0 (and false) for scalars). Setting representsDefault to false is useful if this tree is to be used to marshall back to XML, since JAXB will then not write the values back out to the file
    
    Specified by:
    
    getReadOnlyRoot in interface XmlRootHandle<T>
    
    Parameters:
    representDefaults - If true getters will return default values, if false getters will return null (or zero/false for scalars)
    
    Returns:
    A read-only copy of this xml tree or null if there is no current root for this handle
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class XmlRootHandleImpl<T>

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getRoot

getRootClass

getURI

isAdvertisedInLocator

isAdvertisedInHub

overlay

getXmlRootCopy

addRoot

addRoot

removeRoot

getReadOnlyRoot

toString