|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.xpresso.xml.XmlContent
org.xpresso.xml.Document
org.xpresso.xml.concurrent.ConcurrentDocument
public class ConcurrentDocument
Thread-safe version of Document. Methods are synchronized and the stack can only contain ConcurrentElement.
This code is under the LGPL v3 licence.
Field Summary | |
---|---|
protected java.util.Deque<ConcurrentElement> |
stack
|
Fields inherited from class org.xpresso.xml.Document |
---|
header, open |
Fields inherited from class org.xpresso.xml.XmlContent |
---|
content |
Constructor Summary | |
---|---|
ConcurrentDocument(ConcurrentElement root)
|
|
ConcurrentDocument(java.lang.String xmlVersion,
ConcurrentElement root)
|
|
ConcurrentDocument(java.lang.String xmlVersion,
ConcurrentElement root,
java.lang.String dtdName,
java.lang.String dtdFile)
|
|
ConcurrentDocument(java.lang.String xmlVersion,
java.lang.String encoding,
ConcurrentElement root)
|
|
ConcurrentDocument(java.lang.String xmlVersion,
java.lang.String encoding,
ConcurrentElement root,
boolean standalone)
|
|
ConcurrentDocument(java.lang.String xmlVersion,
java.lang.String encoding,
ConcurrentElement root,
boolean standalone,
java.lang.String dtdName,
java.lang.String dtdFile)
|
|
ConcurrentDocument(java.lang.String xmlVersion,
java.lang.String encoding,
ConcurrentElement root,
java.lang.String dtdName,
java.lang.String dtdFile)
|
Method Summary | |
---|---|
void |
add(XmlContent xmlContent)
Add an XmlContent to the uppest Element of the stack. |
static Document |
createDocument(Element root)
|
static Document |
createDocument(java.lang.String xmlVersion,
Element root)
|
static Document |
createDocument(java.lang.String xmlVersion,
Element root,
java.lang.String dtdName,
java.lang.String dtdFile)
|
static Document |
createDocument(java.lang.String xmlVersion,
java.lang.String encoding,
Element root)
|
static Document |
createDocument(java.lang.String xmlVersion,
java.lang.String encoding,
Element root,
boolean standalone)
|
static Document |
createDocument(java.lang.String xmlVersion,
java.lang.String encoding,
Element root,
boolean standalone,
java.lang.String dtdName,
java.lang.String dtdFile)
|
static Document |
createDocument(java.lang.String xmlVersion,
java.lang.String encoding,
Element root,
java.lang.String dtdName,
java.lang.String dtdFile)
|
static Element |
createElement(java.lang.String label)
|
void |
finish()
Unstack all Elements , which means the document is closed. |
java.lang.String |
getText()
Return the Document as a String which can be added to another Document, which means it has to be closed and that the header informations are discarded. |
java.lang.String |
getXmlText()
Return the Document in its current state of completion. |
static void |
main(java.lang.String[] args)
For test purpose only ! |
void |
stackElement(Element element)
Adds a level of depth to the current branch of the document. |
void |
unstackElement()
Unstack a level of depth from the current branch of the document. |
Methods inherited from class org.xpresso.xml.Document |
---|
charAt, clone, createCdata, createComment, createProcessingInstruction, createText, getStringReader, length, subSequence |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface java.lang.CharSequence |
---|
toString |
Field Detail |
---|
protected java.util.Deque<ConcurrentElement> stack
Constructor Detail |
---|
public ConcurrentDocument(ConcurrentElement root)
public ConcurrentDocument(java.lang.String xmlVersion, ConcurrentElement root, java.lang.String dtdName, java.lang.String dtdFile)
public ConcurrentDocument(java.lang.String xmlVersion, ConcurrentElement root)
public ConcurrentDocument(java.lang.String xmlVersion, java.lang.String encoding, ConcurrentElement root, boolean standalone, java.lang.String dtdName, java.lang.String dtdFile)
public ConcurrentDocument(java.lang.String xmlVersion, java.lang.String encoding, ConcurrentElement root, boolean standalone)
public ConcurrentDocument(java.lang.String xmlVersion, java.lang.String encoding, ConcurrentElement root, java.lang.String dtdName, java.lang.String dtdFile)
public ConcurrentDocument(java.lang.String xmlVersion, java.lang.String encoding, ConcurrentElement root)
Method Detail |
---|
public void add(XmlContent xmlContent) throws ClosedDocumentException
Document
XmlContent
to the uppest Element
of the stack.
add
in class Document
xmlContent
- Content to be added
ClosedDocumentException
- Thrown if the method is added after the document was closedpublic void finish()
Document
Elements
, which means the document is closed.
finish
in class Document
public java.lang.String getText() throws IllegalContentException
Document
getText
in class Document
IllegalContentException
- Thrown if the Document is not closedpublic java.lang.String getXmlText()
Document
Elements
are left on the stack,
getXmlText
in class Document
public void stackElement(Element element) throws ClosedDocumentException
Document
Element
.
stackElement
in class Document
element
- The new Element to be stacked
ClosedDocumentException
- Thrown if the method is added after the document was closedpublic void unstackElement() throws ClosedDocumentException
Document
XmlContent
Element
just below the one unstacked. If this one is the last in
unstackElement
in class Document
ClosedDocumentException
- Thrown if the method is added after the document was closedpublic static Document createDocument(Element root)
public static Document createDocument(java.lang.String xmlVersion, Element root)
public static Document createDocument(java.lang.String xmlVersion, Element root, java.lang.String dtdName, java.lang.String dtdFile)
public static Document createDocument(java.lang.String xmlVersion, java.lang.String encoding, Element root)
public static Document createDocument(java.lang.String xmlVersion, java.lang.String encoding, Element root, java.lang.String dtdName, java.lang.String dtdFile)
public static Document createDocument(java.lang.String xmlVersion, java.lang.String encoding, Element root, boolean standalone)
public static Document createDocument(java.lang.String xmlVersion, java.lang.String encoding, Element root, boolean standalone, java.lang.String dtdName, java.lang.String dtdFile)
public static Element createElement(java.lang.String label)
public static final void main(java.lang.String[] args)
args
-
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |