Package org.apache.abdera.model

Interface Document<T extends Element>

All Superinterfaces:
Base, Cloneable, Serializable
@Deprecated(since="2021-07-29") public interface Document<T extends Element> extends Base, Serializable
Deprecated.
This API is deprecated as Apache Abdera is a retired project since 2017.

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).

  • Method Details

    • getRoot

      T getRoot()
      Deprecated.
      Returns the root element of the document (equivalent to DOM's getDocumentElement)
      Returns:
      The root element of the document

    • setRoot

      Document<T> setRoot(T root)
      Deprecated.
      Sets the root element of the document
      Parameters:
      root - Set the root element of the document

    • getBaseUri

      IRI getBaseUri()
      Deprecated.
      Returns the Base URI of the document. All relative URI's contained in the document will be resolved according to this base.
      Returns:
      The Base IRI

    • setBaseUri

      Document<T> setBaseUri(String base)
      Deprecated.
      Sets the Base URI of the document. All relative URI's contained in the document will be resolved according to this base.
      Parameters:
      base - The Base URI

    • getContentType

      javax.activation.MimeType getContentType()
      Deprecated.
      Returns the content type of this document
      Returns:
      The content type of this document

    • setContentType

      Document<T> setContentType(String contentType)
      Deprecated.
      Sets the content type for this document
      Parameters:
      contentType - The content type of document

    • getLastModified

      Date getLastModified()
      Deprecated.
      Returns the last modified date for this document
      Returns:
      The last-modified date

    • setLastModified

      Document<T> setLastModified(Date lastModified)
      Deprecated.
      Sets the last modified date for this document
      Parameters:
      lastModified - the last-modified date

    • getCharset

      String getCharset()
      Deprecated.
      Gets the charset used for this document
      Returns:
      The character encoding used for this document

    • setCharset

      Document<T> setCharset(String charset)
      Deprecated.
      Sets the charset used for this document
      Parameters:
      charset - The character encoding to use

    • addProcessingInstruction

      Document<T> addProcessingInstruction(String target, String value)
      Deprecated.
      Add a processing instruction to the document
      Parameters:
      target - The processing instruction target
      value - The processing instruction value

    • getProcessingInstruction

      String[] getProcessingInstruction(String target)
      Deprecated.
      Get the values for the given processing instruction

    • addStylesheet

      Document<T> addStylesheet(String href, String media)
      Deprecated.
      Add a xml-stylesheet processing instruction to the document
      Parameters:
      href - The href of the stylesheet
      media - The media target for this stylesheet or null if none

    • getEntityTag

      EntityTag getEntityTag()
      Deprecated.
      Return the entity tag for this document

    • setEntityTag

      Document<T> setEntityTag(EntityTag tag)
      Deprecated.
      Set the entity tag for this document

    • setEntityTag

      Document<T> setEntityTag(String tag)
      Deprecated.
      Set the entity tag for this document

    • getLanguage

      String getLanguage()
      Deprecated.
      Get the language

    • getLanguageTag

      Lang getLanguageTag()
      Deprecated.
      Returns the value of the xml:lang attribute as a Lang object

    • setLanguage

      Document<T> setLanguage(String lang)
      Deprecated.
      set the base language

    • getSlug

      String getSlug()
      Deprecated.
      Get the slug for this document

    • setSlug

      Document<T> setSlug(String slug)
      Deprecated.
      Set the slug for this document

    • getMustPreserveWhitespace

      boolean getMustPreserveWhitespace()
      Deprecated.
      Return true if insignificant whitespace must be preserved

    • setMustPreserveWhitespace

      Document<T> setMustPreserveWhitespace(boolean preserve)
      Deprecated.
      Set to true to preserve insignificant whitespace

    • getXmlVersion

      XmlUtil.XMLVersion getXmlVersion()
      Deprecated.
      Get the XMLVersion used by this document