Top Description Fields Constructors Methods
org.jcp.xml.dsig.internal.dom

public final Class DOMManifest

extends DOMStructure
implements Manifest
Class Inheritance
All Implemented Interfaces
javax.xml.crypto.dsig.Manifest, javax.xml.crypto.XMLStructure
Imports
java.security.Provider, java.util.ArrayList, .Collections, .List, javax.xml.crypto.MarshalException, .XMLCryptoContext, javax.xml.crypto.dom.DOMCryptoContext, javax.xml.crypto.dsig.Manifest, .Reference, .XMLSignature, org.w3c.dom.Document, .Element, .Node

DOM-based implementation of Manifest.

Field Summary

Modifier and TypeField and Description
private final String
private final List<Reference>

Constructor Summary

AccessConstructor and Description
public
DOMManifest(List<? extends Reference>
a list of one or more References. The list is defensively copied to protect against subsequent modification.
references
,
String
the id (may be null
id
)

Creates a DOMManifest containing the specified list of References and optional id.

public
DOMManifest(Element
a Manifest element
manElem
,
XMLCryptoContext context, Provider provider)

Creates a DOMManifest from an element.

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
o
)

Overrides java.lang.Object.equals.

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

public String
getId()

Implements javax.xml.crypto.dsig.Manifest.getId.

Returns the Id of this Manifest.

public static List<Reference>
public List<Reference>
getReferences()

Implements javax.xml.crypto.dsig.Manifest.getReferences.

Returns an unmodifiable list of one or more References that are contained in this Manifest.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public void
Inherited from org.jcp.xml.dsig.internal.dom.DOMStructure:
equalsContentisFeatureSupported

Field Detail

idback to summary
private final String id
referencesback to summary
private final List<Reference> references

Constructor Detail

DOMManifestback to summary
public DOMManifest(List<? extends Reference> references, String id)

Creates a DOMManifest containing the specified list of References and optional id.

Parameters
references:List<? extends Reference>

a list of one or more References. The list is defensively copied to protect against subsequent modification.

id:String

the id (may be null

Exceptions
NullPointerException:
if references is null
IllegalArgumentException:
if references is empty
ClassCastException:
if references contains any entries that are not of type Reference
DOMManifestback to summary
public DOMManifest(Element manElem, XMLCryptoContext context, Provider provider) throws MarshalException

Creates a DOMManifest from an element.

Parameters
manElem:Element

a Manifest element

Method Detail

equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

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.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

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

Annotations
@Override
getIdback to summary
public String getId()

Implements javax.xml.crypto.dsig.Manifest.getId.

Doc from javax.xml.crypto.dsig.Manifest.getId.

Returns the Id of this Manifest.

Returns:String

the Id of this Manifest (or null if not specified)

Annotations
@Override
getManifestReferencesback to summary
public static List<Reference> getManifestReferences(Manifest mf)
Annotations
@SuppressWarnings:unchecked
getReferencesback to summary
public List<Reference> getReferences()

Implements javax.xml.crypto.dsig.Manifest.getReferences.

Doc from javax.xml.crypto.dsig.Manifest.getReferences.

Returns an unmodifiable list of one or more References that are contained in this Manifest.

Returns:List<Reference>

an unmodifiable list of one or more References

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
marshalback to summary
public void marshal(Node parent, String dsPrefix, DOMCryptoContext context) throws MarshalException

Implements abstract org.jcp.xml.dsig.internal.dom.DOMStructure.marshal.

Annotations
@Override