public interface Document<T extends Element> extends Base, Serializable
The top level artifact of the Feed Object Model. The Parser component processes data from an InputStream and returns a Document instance. The type of Document returned depends on the XML format being parsed. The Feed Object Model supports four basic types of documents: FeedDocument, EntryDocument, ServiceDocument (Atom Publishing Protocol Introspection Documents) and XmlDocument (any arbitrary XML).
Modifier and Type | Method and Description |
---|---|
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
|
IRI |
getBaseUri()
Returns the Base URI of the document.
|
String |
getCharset()
Gets the charset used for this document
|
MimeType |
getContentType()
Returns the content type of this document
|
EntityTag |
getEntityTag()
Return the entity tag for this document
|
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
|
T getRoot()
Document<T> setRoot(T root)
root
- Set the root element of the documentIRI getBaseUri()
Document<T> setBaseUri(String base)
base
- The Base URIIRISyntaxException
- if the IRI is malformedMimeType getContentType()
Document<T> setContentType(String contentType)
contentType
- The content type of documentMimeTypeParseException
- if the content type is malformedDate getLastModified()
Document<T> setLastModified(Date lastModified)
lastModified
- the last-modified dateString getCharset()
Document<T> setCharset(String charset)
charset
- The character encoding to useDocument<T> addProcessingInstruction(String target, String value)
target
- The processing instruction targetvalue
- The processing instruction valueString[] getProcessingInstruction(String target)
Document<T> addStylesheet(String href, String media)
href
- The href of the stylesheetmedia
- The media target for this stylesheet or null if noneEntityTag getEntityTag()
String getLanguage()
Lang getLanguageTag()
String getSlug()
boolean getMustPreserveWhitespace()
Document<T> setMustPreserveWhitespace(boolean preserve)
XmlUtil.XMLVersion getXmlVersion()
Copyright © 2010 - 2020 Adobe. All Rights Reserved