org.jcp.xml.dsig.internal.dom
Class DOMXMLObject

java.lang.Object
  org.jcp.xml.dsig.internal.dom.DOMStructure
      org.jcp.xml.dsig.internal.dom.DOMXMLObject

All Implemented Interfaces:

XMLObject, XMLStructure

public final class DOMXMLObject
extends DOMStructure
implements XMLObject

Disabled: no SafeJ information.

DOM-based implementation of XMLObject.

Field Summary

Fields inherited from interface javax.xml.crypto.dsig.XMLObject

TYPE

Constructor Summary

DOMXMLObject(org.w3c.dom.Element objElem, XMLCryptoContext context, Provider provider)
Creates an XMLObject from an element.

DOMXMLObject(List content, String id, String mimeType, String encoding)
Creates an XMLObject from the specified parameters.

Method Summary

boolean	equals(Object o) Indicates whether some other object is "equal to" this one.
List	getContent() Returns an unmodifiable list of XMLStructures contained in this XMLObject, which represent elements from any namespace.
String	getEncoding() Returns the encoding URI of this XMLObject.
String	getId() Returns the Id of this XMLObject.
String	getMimeType() Returns the mime type of this XMLObject.
void	marshal(org.w3c.dom.Node parent, String dsPrefix, DOMCryptoContext context)

Methods inherited from class org.jcp.xml.dsig.internal.dom.DOMStructure

isFeatureSupported

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.xml.crypto.XMLStructure

isFeatureSupported

Constructor Detail

DOMXMLObject

public DOMXMLObject(List content,
                    String id,
                    String mimeType,
                    String encoding)

Class is disabled.

Creates an XMLObject from the specified parameters.

Parameters:

content - a list of XMLStructures. The list is defensively copied to protect against subsequent modification. May be null or empty.

id - the Id (may be null)

mimeType - the mime type (may be null)

encoding - the encoding (may be null)

Throws:

ClassCastException - if content contains any entries that are not of type XMLStructure

DOMXMLObject

public DOMXMLObject(org.w3c.dom.Element objElem,
                    XMLCryptoContext context,
                    Provider provider)
             throws MarshalException

Class is disabled.

Creates an XMLObject from an element.

Parameters:

objElem - an Object element

Throws:

MarshalException - if there is an error when unmarshalling

Method Detail

getContent

public List getContent()

Class is disabled.

Description copied from interface: XMLObject

Returns an unmodifiable list of XMLStructures contained in this XMLObject, which represent elements from any namespace.

If there is a public subclass representing the type of XMLStructure, it is returned as an instance of that class (ex: a SignatureProperties element would be returned as an instance of SignatureProperties).

Specified by:

getContent in interface XMLObject

Returns:

an unmodifiable list of XMLStructures (may be empty but never null)

getId

public String getId()

Class is disabled.

Description copied from interface: XMLObject

Returns the Id of this XMLObject.

Specified by:

getId in interface XMLObject

Returns:

the Id (or null if not specified)

getMimeType

public String getMimeType()

Class is disabled.

Description copied from interface: XMLObject

Returns the mime type of this XMLObject. The mime type is an optional attribute which describes the data within this XMLObject (independent of its encoding).

Specified by:

getMimeType in interface XMLObject

Returns:

the mime type (or null if not specified)

getEncoding

public String getEncoding()

Class is disabled.

Description copied from interface: XMLObject

Returns the encoding URI of this XMLObject. The encoding URI identifies the method by which the object is encoded.

Specified by:

getEncoding in interface XMLObject

Returns:

the encoding URI (or null if not specified)

marshal

public void marshal(org.w3c.dom.Node parent,
                    String dsPrefix,
                    DOMCryptoContext context)
             throws MarshalException

Class is disabled.

Specified by:

marshal in class DOMStructure

Throws:

MarshalException

equals

public boolean equals(Object o)

Enabled. assumes no non-deterministic equals methods in libraries

Description copied from class: Object

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Overrides:

equals in class Object

Parameters:

o - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

See Also:

Object.hashCode(), HashMap