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

public final Class DOMSignatureProperty

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

DOM-based implementation of SignatureProperty.

Field Summary

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

Constructor Summary

AccessConstructor and Description
public
DOMSignatureProperty(List<? extends XMLStructure>
a list of one or more XMLStructures. The list is defensively copied to protect against subsequent modification.
content
,
String
the target URI
target
,
String
the Id (may be null)
id
)

Creates a SignatureProperty from the specified parameters.

public
DOMSignatureProperty(Element
a SignatureProperty element
propElem
)

Creates a DOMSignatureProperty from an element.

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object o)

Overrides java.lang.Object.equals.

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

public List<XMLStructure>
getContent()

Implements javax.xml.crypto.dsig.SignatureProperty.getContent.

Returns an unmodifiable list of one or more XMLStructures that are contained in this SignatureProperty.

public String
getId()

Implements javax.xml.crypto.dsig.SignatureProperty.getId.

Returns the Id of this SignatureProperty.

public String
getTarget()

Implements javax.xml.crypto.dsig.SignatureProperty.getTarget.

Returns the target URI of this SignatureProperty.

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

contentback to summary
private final List<XMLStructure> content
idback to summary
private final String id
targetback to summary
private final String target

Constructor Detail

DOMSignaturePropertyback to summary
public DOMSignatureProperty(List<? extends XMLStructure> content, String target, String id)

Creates a SignatureProperty from the specified parameters.

Parameters
content:List<? extends XMLStructure>

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

target:String

the target URI

id:String

the Id (may be null)

Exceptions
ClassCastException:
if content contains any entries that are not of type XMLStructure
IllegalArgumentException:
if content is empty
NullPointerException:
if content or target is null
DOMSignaturePropertyback to summary
public DOMSignatureProperty(Element propElem) throws MarshalException

Creates a DOMSignatureProperty from an element.

Parameters
propElem:Element

a SignatureProperty 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.

Annotations
@Override
getContentback to summary
public List<XMLStructure> getContent()

Implements javax.xml.crypto.dsig.SignatureProperty.getContent.

Doc from javax.xml.crypto.dsig.SignatureProperty.getContent.

Returns an unmodifiable list of one or more XMLStructures that are contained in this SignatureProperty. These represent additional information items concerning the generation of the XMLSignature (i.e. date/time stamp or serial numbers of cryptographic hardware used in signature generation).

Annotations
@Override
getIdback to summary
public String getId()

Implements javax.xml.crypto.dsig.SignatureProperty.getId.

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

Returns the Id of this SignatureProperty.

Annotations
@Override
getTargetback to summary
public String getTarget()

Implements javax.xml.crypto.dsig.SignatureProperty.getTarget.

Doc from javax.xml.crypto.dsig.SignatureProperty.getTarget.

Returns the target URI of this SignatureProperty.

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.
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