com.ibm.websphere.management.repository

Class Document

  • java.lang.Object
    • com.ibm.websphere.management.repository.Document
  • All Implemented Interfaces:
    java.io.Serializable


    public class Document
    extends java.lang.Object
    implements java.io.Serializable
    A Document instance contains information about a document in the configuration repository. Its main purpose is to identify the location of the document contents using a fully qualified document name. It also contains a DocumentDigest that can be used for document content comparison.

    Note that creating a new Document instance does not physically create a new object in the file system; it simply creates a new reference to a particular location.

    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor and Description
      Document(java.lang.String docURI)
      Creates a new reference to a document with the given location.
      Document(java.lang.String docURI, DocumentDigest digest)
      Creates a new reference to a document with the given location and digest.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      DocumentDigest getDigest()
      Returns the digest of this document
      boolean getOverwrite()
      Not for public use.
      java.lang.String getTempName()
      Returns a temporary name for this document, consisting of the URI plus the digest (if any).
      java.lang.String getURI()
      Returns the location referred to by this document.
      void setOverwrite(boolean b)
      Not for public use.
      void setURI(java.lang.String newURI)
      Sets the URI of this document instance.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • Document

        public Document(java.lang.String docURI,
                DocumentDigest digest)
        Creates a new reference to a document with the given location and digest.
        Parameters:
        docURI - URI specifying the location of this document
        digest - the digest for this document
      • Document

        public Document(java.lang.String docURI)
        Creates a new reference to a document with the given location. The digest will be set to null.
        Parameters:
        docURI - URI specifying the location of this document
    • Method Detail

      • getURI

        public java.lang.String getURI()
        Returns the location referred to by this document.
        Returns:
        a URI indicating this document's location
      • setURI

        public void setURI(java.lang.String newURI)
        Sets the URI of this document instance. Any previous URI will be overwritten.
        Parameters:
        newURI - a URI indicating the document location
      • getDigest

        public DocumentDigest getDigest()
        Returns the digest of this document
        Returns:
        the digest that was previously set for this document
      • getTempName

        public java.lang.String getTempName()
        Returns a temporary name for this document, consisting of the URI plus the digest (if any).
        Returns:
        a string containing a temporary name for this document
      • getOverwrite

        public boolean getOverwrite()
        Not for public use.
        Returns:
        Not for public use
      • setOverwrite

        public void setOverwrite(boolean b)
        Not for public use.
        Parameters:
        b - Not for public use
IBM WebSphere Application ServerTM
Release 9.0