public abstract class XmlDocumentProperties extends Object
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);
Modifier and Type | Field and Description |
---|---|
static Object |
DOCTYPE_NAME
Doc type name
|
static Object |
DOCTYPE_PUBLIC_ID
Doc type public id
|
static Object |
DOCTYPE_SYSTEM_ID
Doc type system id
|
static Object |
ENCODING
Document encoding
|
static Object |
MESSAGE_DIGEST
SHA message digest
|
static Object |
SOURCE_NAME
Used to store the original name (a String) for
the source from which the XML document was loaded.
|
static Object |
STANDALONE
Document standlone
|
static Object |
VERSION
Document version
|
Constructor and Description |
---|
XmlDocumentProperties() |
Modifier and Type | Method and Description |
---|---|
abstract Object |
get(Object key)
Returns a value previously attached to a document using set.
|
String |
getDoctypeName()
Returns the DOCTYPE name used in the <!DOCTYPE> declaration.
|
String |
getDoctypePublicId()
Returns the DOCTYPE public ID used in the <!DOCTYPE> declaration.
|
String |
getDoctypeSystemId()
Returns the DOCTYPE system ID used in the <!DOCTYPE> declaration.
|
String |
getEncoding()
Returns the encoding used for the XML document, as an ISO encoding name.
|
byte[] |
getMessageDigest()
Returns the message digest used to summarize the document.
|
String |
getSourceName()
Returns the name of the XML document file.
|
boolean |
getStandalone()
Returns the standalone property
|
String |
getVersion()
Returns the XML version string used in the <?xml?> declaration.
|
abstract Object |
put(Object key,
Object value)
Attaches a value to the root of the document containing
the given token source.
|
abstract Object |
remove(Object key)
Removes a value previously attached to a document using set.
|
void |
setDoctypeName(String doctypename)
Sets the DOCTYPE name use in the <!DOCTYPE> declaration.
|
void |
setDoctypePublicId(String publicid)
Sets the DOCTYPE public ID to use in the <!DOCTYPE> declaration.
|
void |
setDoctypeSystemId(String systemid)
Sets the DOCTYPE system ID to use in the <!DOCTYPE> declaration.
|
void |
setEncoding(String encoding)
Sets the encoding to use for the XML document.
|
void |
setMessageDigest(byte[] digest)
Sets the message digest used to summarize the document.
|
void |
setSourceName(String sourceName)
Sets the name of the XML document file.
|
void |
setStandalone(boolean standalone)
Sets the standalone property.
|
void |
setVersion(String version)
Sets the XML version string to use in the <?xml?> declaration.
|
public static final Object SOURCE_NAME
public static final Object ENCODING
public static final Object VERSION
public static final Object STANDALONE
public static final Object DOCTYPE_NAME
public static final Object DOCTYPE_PUBLIC_ID
public static final Object DOCTYPE_SYSTEM_ID
public static final Object MESSAGE_DIGEST
public void setSourceName(String sourceName)
sourceName
- the name to setXmlOptions.setDocumentSourceName(java.lang.String)
public String getSourceName()
public void setEncoding(String encoding)
encoding
- the ISO encoding nameXmlOptions.setCharacterEncoding(java.lang.String)
public String getEncoding()
public void setVersion(String version)
version
- the XML version stringpublic String getVersion()
public void setStandalone(boolean standalone)
standalone
- whether standalone is true or notpublic boolean getStandalone()
public void setDoctypeName(String doctypename)
doctypename
- the doctypenamepublic String getDoctypeName()
public void setDoctypePublicId(String publicid)
publicid
- the public IDpublic String getDoctypePublicId()
public void setDoctypeSystemId(String systemid)
systemid
- the system IDpublic String getDoctypeSystemId()
public void setMessageDigest(byte[] digest)
digest
- the bytes of the digestXmlOptions.setLoadMessageDigest()
public byte[] getMessageDigest()
XmlOptions.setLoadMessageDigest()
public abstract Object put(Object key, Object value)
key
- The key: there can be one value for each key.value
- The value to attach to the document.public abstract Object get(Object key)
key
- The key: this is the key that was previously
passed to set to store the value.Copyright © 2010 - 2020 Adobe. All Rights Reserved