# com.bea.xml
XmlDocumentProperties Class

public abstract class XmlDocumentProperties
extends `Object`

This class is used to attach arbitrary information to an XML document. It also defines several well-known types of information that can be attached or found on a document.

For example, suppose you wanted to associate a filename with the document containing an xml object "xobj". This could be done via the following code:

tokenSource.documentProperties().set(XmlDocumentProperties.NAME, "MyFilename.xml");

To fetch the filename later, given an xobj2 anywhere in the same document, you can write:

filename = (String)tokenSource.documentProperties().get(XmlDocumentProperties.NAME);

Hierarchy
  `Object`
  `XmlDocumentProperties`

## Field Summary

`public static final `Object`` | `DOCTYPE_NAME` Doc type name
`public static final `Object`` | `DOCTYPE_PUBLIC_ID` Doc type public id
`public static final `Object`` | `DOCTYPE_SYSTEM_ID` Doc type system id
`public static final `Object`` | `ENCODING` Document encoding
`public static final `Object`` | `MESSAGE_DIGEST` SHA message digest
`public static final `Object`` | `SOURCE_NAME` Used to store the original name (a String) for the source from which the XML document was loaded.
`public static final `Object`` | `VERSION` Document version

## Constructor Summary

XmlDocumentProperties()

## Method Summary

`public abstract `Object`` | `get`(`Object` key) Returns a value previously attached to a document using set.
`public `String`` | `getDoctypeName`() Returns the DOCTYPE name used in the <!DOCTYPE> declaration.
`public `String`` | `getDoctypePublicId`() Returns the DOCTYPE public ID used in the <!DOCTYPE> declaration.
`public `String`` | `getDoctypeSystemId`() Returns the DOCTYPE system ID used in the <!DOCTYPE> declaration.
`public `String`` | `getEncoding`() Returns the encoding used for the XML document, as an ISO encoding name.
`public byte[]` | `getMessageDigest`() Returns the message digest used to summarize the document.
`public `String`` | `getSourceName`() Returns the name of the XML document file.
`public `String`` | `getVersion`() Returns the XML version string used in the <?xml?> declaration.
`public abstract `Object`` | `put`(`Object` key, `Object` value) Attaches a value to the root of the document containing the given token source.
`public abstract `Object`` | `remove`(`Object` key) Removes a value previously attached to a document using set.
`public void` | `setDoctypeName`(`String` doctypename) Sets the DOCTYPE name use in the <!DOCTYPE> declaration.
`public void` | `setDoctypePublicId`(`String` publicid) Sets the DOCTYPE public ID to use in the <!DOCTYPE> declaration.
`public void` | `setDoctypeSystemId`(`String` systemid) Sets the DOCTYPE system ID to use in the <!DOCTYPE> declaration.
`public void` | `setEncoding`(`String` encoding) Sets the encoding to use for the XML document.
`public void` | `setMessageDigest`(byte[] digest) Sets the message digest used to summarize the document.
`public void` | `setSourceName`(`String` sourceName) Sets the name of the XML document file.
`public void` | `setVersion`(`String` version) Sets the XML version string to use in the <?xml?> declaration.

Methods from class `java.lang.`Object``
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

## Field Detail

### DOCTYPE_NAME

    public static final Object DOCTYPE_NAME

  Doc type name

### DOCTYPE_PUBLIC_ID

    public static final Object DOCTYPE_PUBLIC_ID

  Doc type public id

### DOCTYPE_SYSTEM_ID

    public static final Object DOCTYPE_SYSTEM_ID

  Doc type system id

### ENCODING

    public static final Object ENCODING

  Document encoding

### MESSAGE_DIGEST

    public static final Object MESSAGE_DIGEST

  SHA message digest

### SOURCE_NAME

    public static final Object SOURCE_NAME

  Used to store the original name (a String) for the source from which the XML document was loaded. This name, if present, is used to identify the document when reporting validation or comilation errors. XmlObject.Factory.parse(File) and SchemaTypeLoader.loadInstance(File) both automatically set this value to the filename.

### VERSION

    public static final Object VERSION

  Document version

## Constructor Detail

### XmlDocumentProperties

    public XmlDocumentProperties()

## Method Detail

### get(Object) Method

    public abstract Object get(Object key)

Returns a value previously attached to a document using set.

#### Parameters

key
  The key: this is the key that was previously passed to set to store the value.

#### Returns

The saved value, or null if none is found.

### getDoctypeName() Method

    public String getDoctypeName()

Returns the DOCTYPE name used in the <!DOCTYPE> declaration.

### getDoctypePublicId() Method

    public String getDoctypePublicId()

Returns the DOCTYPE public ID used in the <!DOCTYPE> declaration.

### getDoctypeSystemId() Method

    public String getDoctypeSystemId()

Returns the DOCTYPE system ID used in the <!DOCTYPE> declaration.

### getEncoding() Method

    public String getEncoding()

Returns the encoding used for the XML document, as an ISO encoding name.

Related Topics

``XmlOptions.setCharacterEncoding(String)``

### getMessageDigest() Method

    public byte[] getMessageDigest()

Returns the message digest used to summarize the document.

Related Topics

``XmlOptions.setLoadMessageDigest()``

### getSourceName() Method

    public String getSourceName()

Returns the name of the XML document file. Typically a URL, but may be any String.

Related Topics

``XmlOptions.setDocumentSourceName(String)``

### getVersion() Method

    public String getVersion()

Returns the XML version string used in the <?xml?> declaration.

### put(Object, Object) Method

    public abstract Object put(Object key,
                               Object value)

Attaches a value to the root of the document containing the given token source.

#### Parameters

key
  The key: there can be one value for each key.

value
  The value to attach to the document.

### remove(Object) Method

    public abstract Object remove(Object key)

Removes a value previously attached to a document using set.

#### Parameters

key
  The key: this is the key that was previously passed to set to store the value.

### setDoctypeName(String) Method

    public void setDoctypeName(String doctypename)

Sets the DOCTYPE name use in the <!DOCTYPE> declaration.

#### Parameters

doctypename
  the doctypename

### setDoctypePublicId(String) Method

    public void setDoctypePublicId(String publicid)

Sets the DOCTYPE public ID to use in the <!DOCTYPE> declaration.

#### Parameters

publicid
  the public ID

### setDoctypeSystemId(String) Method

    public void setDoctypeSystemId(String systemid)

Sets the DOCTYPE system ID to use in the <!DOCTYPE> declaration.

#### Parameters

systemid
  the system ID

### setEncoding(String) Method

    public void setEncoding(String encoding)

Sets the encoding to use for the XML document. Should be a valid XML encoding string.

#### Parameters

encoding
  the ISO encoding name

Related Topics

``XmlOptions.setCharacterEncoding(String)``

### setMessageDigest(byte[]) Method

    public void setMessageDigest(byte[] digest)

Sets the message digest used to summarize the document.

#### Parameters

digest
  the bytes of the digest

Related Topics

``XmlOptions.setLoadMessageDigest()``

### setSourceName(String) Method

    public void setSourceName(String sourceName)

Sets the name of the XML document file. Typically a URL, but may be any String.

#### Parameters

sourceName
  the name to set

Related Topics

``XmlOptions.setDocumentSourceName(String)``

### setVersion(String) Method

    public void setVersion(String version)

Sets the XML version string to use in the <?xml?> declaration. (The XML specification is quite stable at "1.0".)

#### Parameters

version
  the XML version string