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

public final Class DOMKeyName

extends DOMStructure
implements KeyName
Class Inheritance
All Implemented Interfaces
javax.xml.crypto.dsig.keyinfo.KeyName, javax.xml.crypto.XMLStructure
Imports
javax.xml.crypto.MarshalException, javax.xml.crypto.dom.DOMCryptoContext, javax.xml.crypto.dsig.XMLSignature, javax.xml.crypto.dsig.keyinfo.KeyName, org.w3c.dom.Document, .Element, .Node

DOM-based implementation of KeyName.

Field Summary

Modifier and TypeField and Description
private final String

Constructor Summary

AccessConstructor and Description
public
DOMKeyName(String
the name of the key identifier
name
)

Creates a DOMKeyName.

public
DOMKeyName(Element
a KeyName element
knElem
)

Creates a DOMKeyName from a KeyName element.

Method Summary

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

Overrides java.lang.Object.equals.

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

public String
getName()

Implements javax.xml.crypto.dsig.keyinfo.KeyName.getName.

Returns the name of this KeyName.

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

nameback to summary
private final String name

Constructor Detail

DOMKeyNameback to summary
public DOMKeyName(String name)

Creates a DOMKeyName.

Parameters
name:String

the name of the key identifier

Exceptions
NullPointerException:
if name is null
DOMKeyNameback to summary
public DOMKeyName(Element knElem)

Creates a DOMKeyName from a KeyName element.

Parameters
knElem:Element

a KeyName element

Method Detail

equalsback to summary
public boolean equals(Object obj)

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
getNameback to summary
public String getName()

Implements javax.xml.crypto.dsig.keyinfo.KeyName.getName.

Doc from javax.xml.crypto.dsig.keyinfo.KeyName.getName.

Returns the name of this KeyName.

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