|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.axiom.om.impl.llom.OMDocumentImpl
org.apache.abdera.parser.stax.FOMDocument<T>
public class FOMDocument<T extends Element>
Field Summary | |
---|---|
protected IRI |
base
|
protected javax.activation.MimeType |
contentType
|
protected EntityTag |
etag
|
protected String |
language
|
protected Date |
lastModified
|
protected boolean |
preserve
|
protected String |
slug
|
Fields inherited from class org.apache.axiom.om.impl.llom.OMDocumentImpl |
---|
charSetEncoding, documentElement, done, factory, firstChild, isStandalone, lastChild, parserWrapper, xmlVersion |
Fields inherited from interface org.apache.axiom.om.OMDocument |
---|
XML_10, XML_11 |
Constructor Summary | |
---|---|
|
FOMDocument()
|
protected |
FOMDocument(org.apache.axiom.om.OMElement documentElement,
org.apache.axiom.om.OMXMLParserWrapper parserWrapper)
|
protected |
FOMDocument(org.apache.axiom.om.OMElement documentElement,
org.apache.axiom.om.OMXMLParserWrapper parserWrapper,
org.apache.axiom.om.OMFactory factory)
|
protected |
FOMDocument(org.apache.axiom.om.OMFactory factory)
|
protected |
FOMDocument(org.apache.axiom.om.OMXMLParserWrapper parserWrapper)
|
protected |
FOMDocument(org.apache.axiom.om.OMXMLParserWrapper parserWrapper,
org.apache.axiom.om.OMFactory factory)
|
Method Summary | ||
---|---|---|
|
addComment(String value)
Add an XML comment to this Base |
|
Document<T> |
addProcessingInstruction(String target,
String value)
Add a processing instruction to the document |
|
Document<T> |
addStylesheet(String href,
String media)
Add a xml-stylesheet processing instruction to the document |
|
Object |
clone()
Clone this Base |
|
|
complete()
Ensure that the underlying streams are fully parsed. |
|
IRI |
getBaseUri()
Returns the Base URI of the document. |
|
String |
getCharset()
Gets the charset used for this document |
|
javax.activation.MimeType |
getContentType()
Returns the content type of this document |
|
WriterOptions |
getDefaultWriterOptions()
Get the default WriterOptions for this object |
|
EntityTag |
getEntityTag()
Return the entity tag for this document |
|
Factory |
getFactory()
Get the Factory used to create this Base |
|
String |
getLanguage()
Get the language |
|
Lang |
getLanguageTag()
Returns the value of the xml:lang attribute as a Lang object |
|
Date |
getLastModified()
Returns the last modified date for this document |
|
boolean |
getMustPreserveWhitespace()
Return true if insignificant whitespace must be preserved |
|
String[] |
getProcessingInstruction(String target)
Get the values for the given processing instruction |
|
T |
getRoot()
Returns the root element of the document (equivalent to DOM's getDocumentElement) |
|
String |
getSlug()
Get the slug for this document |
|
XmlUtil.XMLVersion |
getXmlVersion()
Get the XMLVersion used by this document |
|
Document<T> |
setBaseUri(String base)
Sets the Base URI of the document. |
|
Document<T> |
setCharset(String charset)
Sets the charset used for this document |
|
Document<T> |
setContentType(String contentType)
Sets the content type for this document |
|
Document<T> |
setEntityTag(EntityTag tag)
Set the entity tag for this document |
|
Document<T> |
setEntityTag(String tag)
Set the entity tag for this document |
|
Document<T> |
setLanguage(String lang)
set the base language |
|
Document<T> |
setLastModified(Date lastModified)
Sets the last modified date for this document |
|
Document<T> |
setMustPreserveWhitespace(boolean preserve)
Set to true to preserve insignificant whitespace |
|
Document<T> |
setRoot(T root)
Sets the root element of the document |
|
Document<T> |
setSlug(String slug)
Set the slug for this document |
|
String |
toFormattedString()
|
|
void |
writeTo(OutputStream out)
Serializes the model component out to the specified stream |
|
void |
writeTo(OutputStream out,
WriterOptions options)
Serializes the model component out to the specified stream |
|
void |
writeTo(String writer,
OutputStream out)
Serializes the model component out to the specified stream using the given Abdera writer |
|
void |
writeTo(String writer,
OutputStream out,
WriterOptions options)
Serializes the model component out to the specified stream using the given abdera writer |
|
void |
writeTo(String writer,
Writer out)
Serializes the model component out to the specified java.io.Writer using the given Abdera writer |
|
void |
writeTo(String writer,
Writer out,
WriterOptions options)
Serializes the model component out to the specified java.io.Writer using the given abdera writer |
|
void |
writeTo(Writer writer)
Serializes the model component out to the specified writer |
|
void |
writeTo(Writer writer,
OutputStream out)
Serializes the model component out to the specified stream using the given Abdera writer |
|
void |
writeTo(Writer writer,
OutputStream out,
WriterOptions options)
Serializes the model component out to the specified stream using the given abdera writer |
|
void |
writeTo(Writer writer,
Writer out)
Serializes the model component out to the specified java.io.Writer using the given Abdera writer |
|
void |
writeTo(Writer out,
WriterOptions options)
Serializes the model component out to the specified java.io.Writer |
|
void |
writeTo(Writer writer,
Writer out,
WriterOptions options)
Serializes the model component out to the specified java.io.Writer using the given abdera writer |
Methods inherited from class org.apache.axiom.om.impl.llom.OMDocumentImpl |
---|
addChild, buildNext, getCharsetEncoding, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getFirstChildWithName, getFirstOMChild, getOMDocumentElement, getOMFactory, getXMLVersion, internalSerialize, internalSerialize, internalSerialize, internalSerializeAndConsume, internalSerializeAndConsume, isComplete, isStandalone, serialize, serialize, serializeAndConsume, serializeAndConsume, setCharsetEncoding, setComplete, setFirstChild, setLastChild, setOMDocumentElement, setStandalone, setXMLVersion |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected IRI base
protected javax.activation.MimeType contentType
protected Date lastModified
protected EntityTag etag
protected String language
protected String slug
protected boolean preserve
Constructor Detail |
---|
public FOMDocument()
protected FOMDocument(org.apache.axiom.om.OMElement documentElement, org.apache.axiom.om.OMXMLParserWrapper parserWrapper, org.apache.axiom.om.OMFactory factory)
protected FOMDocument(org.apache.axiom.om.OMElement documentElement, org.apache.axiom.om.OMXMLParserWrapper parserWrapper)
protected FOMDocument(org.apache.axiom.om.OMFactory factory)
protected FOMDocument(org.apache.axiom.om.OMXMLParserWrapper parserWrapper, org.apache.axiom.om.OMFactory factory)
protected FOMDocument(org.apache.axiom.om.OMXMLParserWrapper parserWrapper)
Method Detail |
---|
public T getRoot()
Document
getRoot
in interface Document<T extends Element>
public Document<T> setRoot(T root)
Document
setRoot
in interface Document<T extends Element>
root
- Set the root element of the documentpublic IRI getBaseUri()
Document
getBaseUri
in interface Document<T extends Element>
public Document<T> setBaseUri(String base)
Document
setBaseUri
in interface Document<T extends Element>
base
- The Base URIpublic void writeTo(OutputStream out, WriterOptions options) throws IOException
Base
writeTo
in interface Base
out
- The target output streamoptions
- The WriterOptions to use
IOException
public void writeTo(Writer out, WriterOptions options) throws IOException
Base
writeTo
in interface Base
out
- The target output writeroptions
- The WriterOptions to use
IOException
public void writeTo(Writer writer, OutputStream out) throws IOException
Base
writeTo
in interface Base
writer
- The Abdera writer to useout
- The target output stream
IOException
public void writeTo(Writer writer, Writer out) throws IOException
Base
writeTo
in interface Base
writer
- The Abdera writer to useout
- The target output writer
IOException
public void writeTo(Writer writer, OutputStream out, WriterOptions options) throws IOException
Base
writeTo
in interface Base
writer
- The Abdera writer to useout
- The target output streamoptions
- The WriterOptions to use
IOException
public void writeTo(Writer writer, Writer out, WriterOptions options) throws IOException
Base
writeTo
in interface Base
writer
- The Abdera writer to useout
- The target output writeroptions
- The WriterOptions to use
IOException
public void writeTo(OutputStream out) throws IOException
Base
writeTo
in interface Base
out
- The java.io.OutputStream to use when serializing the Base. The charset encoding specified for the
document will be used
IOException
public void writeTo(Writer writer) throws IOException
Base
writeTo
in interface Base
writer
- The java.io.Writer to use when serializing the Base
IOException
public javax.activation.MimeType getContentType()
Document
getContentType
in interface Document<T extends Element>
public Document<T> setContentType(String contentType)
Document
setContentType
in interface Document<T extends Element>
contentType
- The content type of documentpublic Date getLastModified()
Document
getLastModified
in interface Document<T extends Element>
public Document<T> setLastModified(Date lastModified)
Document
setLastModified
in interface Document<T extends Element>
lastModified
- the last-modified datepublic Object clone()
Base
clone
in interface Base
clone
in class Object
public String getCharset()
Document
getCharset
in interface Document<T extends Element>
public Document<T> setCharset(String charset)
Document
setCharset
in interface Document<T extends Element>
charset
- The character encoding to usepublic Factory getFactory()
Base
getFactory
in interface Base
public String[] getProcessingInstruction(String target)
Document
getProcessingInstruction
in interface Document<T extends Element>
public Document<T> addProcessingInstruction(String target, String value)
Document
addProcessingInstruction
in interface Document<T extends Element>
target
- The processing instruction targetvalue
- The processing instruction valuepublic Document<T> addStylesheet(String href, String media)
Document
addStylesheet
in interface Document<T extends Element>
href
- The href of the stylesheetmedia
- The media target for this stylesheet or null if nonepublic <X extends Base> X addComment(String value)
Base
addComment
in interface Base
value
- The text value of the commentpublic EntityTag getEntityTag()
Document
getEntityTag
in interface Document<T extends Element>
public Document<T> setEntityTag(EntityTag tag)
Document
setEntityTag
in interface Document<T extends Element>
public Document<T> setEntityTag(String tag)
Document
setEntityTag
in interface Document<T extends Element>
public String getLanguage()
Document
getLanguage
in interface Document<T extends Element>
public Lang getLanguageTag()
Document
getLanguageTag
in interface Document<T extends Element>
public Document<T> setLanguage(String lang)
Document
setLanguage
in interface Document<T extends Element>
public String getSlug()
Document
getSlug
in interface Document<T extends Element>
public Document<T> setSlug(String slug)
Document
setSlug
in interface Document<T extends Element>
public boolean getMustPreserveWhitespace()
Document
getMustPreserveWhitespace
in interface Document<T extends Element>
public Document<T> setMustPreserveWhitespace(boolean preserve)
Document
setMustPreserveWhitespace
in interface Document<T extends Element>
public XmlUtil.XMLVersion getXmlVersion()
Document
getXmlVersion
in interface Document<T extends Element>
public WriterOptions getDefaultWriterOptions()
Base
getDefaultWriterOptions
in interface Base
public <X extends Base> X complete()
complete
in interface Base
public void writeTo(String writer, OutputStream out) throws IOException
Base
writeTo
in interface Base
writer
- The Abdera writer to useout
- The target output stream
IOException
public void writeTo(String writer, Writer out) throws IOException
Base
writeTo
in interface Base
writer
- The Abdera writer to useout
- The target output writer
IOException
public void writeTo(String writer, OutputStream out, WriterOptions options) throws IOException
Base
writeTo
in interface Base
writer
- The name of the Abdera writer to useout
- The target output streamoptions
- The WriterOptions to use
IOException
public void writeTo(String writer, Writer out, WriterOptions options) throws IOException
Base
writeTo
in interface Base
writer
- The name of the Abdera writer to useout
- The target output writeroptions
- The WriterOptions to use
IOException
public String toFormattedString()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |