org.openestate.io.trovit

Class TrovitDocument

java.lang.Object

org.openestate.io.core.XmlDocument<Trovit>

org.openestate.io.trovit.TrovitDocument

public class TrovitDocument
extends XmlDocument<Trovit>

Trovit-XML document with a <trovit> root element.

Since:

1.0

Author:

Andreas Rudolph

Constructor Summary

Constructors

Constructor and Description
TrovitDocument(Document document) Create from a Document.

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	isReadable(Document doc) Checks, if a Document is readable as a TrovitDocument.
static TrovitDocument	newDocument() Creates an empty TrovitDocument.
static TrovitDocument	newDocument(Trovit trovit) Creates a TrovitDocument from a Trovit object.
Trovit	toObject() Creates a Trovit object from the contained Document.

Methods inherited from class org.openestate.io.core.XmlDocument

getDocument, isTextWrittenAsCDATA, prepareDocumentBeforeWritingToXml, setTextWrittenAsCDATA, toXml, toXml, toXml, toXml, toXml, toXml, toXmlString, toXmlString

Methods inherited from class java.lang.Object

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

Constructor Detail

TrovitDocument

public TrovitDocument(Document document)

Create from a Document.

Parameters:

document - the document to create from

Method Detail

isReadable

public static boolean isReadable(Document doc)

Checks, if a Document is readable as a TrovitDocument.

Parameters:

doc - document to check

Returns:

true, if the document is usable, otherwise false

newDocument

public static TrovitDocument newDocument()
                                  throws ParserConfigurationException,
                                         JAXBException

Creates an empty TrovitDocument.

Returns:

created document

Throws:

ParserConfigurationException - if the parser is not properly configured

JAXBException - if a problem with JAXB occured

newDocument

public static TrovitDocument newDocument(Trovit trovit)
                                  throws ParserConfigurationException,
                                         JAXBException

Creates a TrovitDocument from a Trovit object.

Parameters:

trovit - Java object, that represents the <trovit> root element

Returns:

created document

Throws:

ParserConfigurationException - if the parser is not properly configured

JAXBException - if a problem with JAXB occured

toObject

public Trovit toObject()
                throws JAXBException

Creates a Trovit object from the contained Document.

Specified by:

toObject in class XmlDocument<Trovit>

Returns:

created object, that represents the <trovit> root element

Throws:

JAXBException - if a problem with JAXB occured