OpenJDK 27 · org.jcp.xml.dsig.internal.dom.DOMXMLObject

Modifier and Type	Field and Description
private final List<XMLStructure>	content
private final String	encoding
private final String	id
private final String	mimeType
private Element	objectElem

Access	Constructor and Description
public	DOMXMLObject(List<? extends XMLStructure> a list of `XMLStructure`s. The list is defensively copied to protect against subsequent modification. May be `null` or empty. content, String the Id (may be `null`) id, String the mime type (may be `null`) mimeType, String the encoding (may be `null`) encoding) Creates an `XMLObject` from the specified parameters.
public	DOMXMLObject(Element an Object element objElem, XMLCryptoContext context, Provider provider) Creates an `XMLObject` from an element.

Method Summary

Modifier and Type	Method 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.XMLObject.getContent. Returns an `unmodifiable list` of `XMLStructure`s contained in this `XMLObject`, which represent elements from any namespace.
public String	getEncoding() Implements javax.xml.crypto.dsig.XMLObject.getEncoding. Returns the encoding URI of this `XMLObject`.
public String	getId() Implements javax.xml.crypto.dsig.XMLObject.getId. Returns the Id of this `XMLObject`.
public String	getMimeType() Implements javax.xml.crypto.dsig.XMLObject.getMimeType. Returns the mime type of this `XMLObject`.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public void	marshal(Node parent, String dsPrefix, DOMCryptoContext context) Implements abstract org.jcp.xml.dsig.internal.dom.DOMStructure.marshal.

Inherited from org.jcp.xml.dsig.internal.dom.DOMStructure:: equalsContent isFeatureSupported

Field Detail

content	back to summary
private final List<XMLStructure> content

encoding	back to summary
private final String encoding

id	back to summary
private final String id

mimeType	back to summary
private final String mimeType

objectElem	back to summary
private Element objectElem

Constructor Detail

DOMXMLObject back to summary

DOMXMLObject	back to summary
public DOMXMLObject(List<? extends XMLStructure> content, String id, String mimeType, String encoding) Creates an `XMLObject` from the specified parameters. Parameters content:List<? extends XMLStructure> a list of `XMLStructure`s. The list is defensively copied to protect against subsequent modification. May be `null` or empty. id:String the Id (may be `null`) mimeType:String the mime type (may be `null`) encoding:String the encoding (may be `null`) Exceptions ClassCastException: if `content` contains any entries that are not of type `XMLStructure`

public DOMXMLObject(List<? extends XMLStructure> content, String id, String mimeType, String encoding)

Creates an XMLObject from the specified parameters.

Parameters

content:List<? extends XMLStructure>: a list of XMLStructures. The list is defensively copied to protect against subsequent modification. May be null or empty.
id:String: the Id (may be null)
mimeType:String: the mime type (may be null)
encoding:String: the encoding (may be null)

Exceptions

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

DOMXMLObject back to summary

DOMXMLObject	back to summary
public DOMXMLObject(Element objElem, XMLCryptoContext context, Provider provider) throws MarshalException Creates an `XMLObject` from an element. Parameters objElem:Element an Object element Exceptions MarshalException: if there is an error when unmarshalling

public DOMXMLObject(Element objElem, XMLCryptoContext context, Provider provider) throws MarshalException

Creates an XMLObject from an element.

Parameters

objElem:Element: an Object element

Exceptions

MarshalException:: if there is an error when unmarshalling

Method Detail

equals back to summary

equals	back 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 @SuppressWarnings:unchecked @Override

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

@SuppressWarnings:unchecked
@Override

getContent back to summary

getContent	back to summary
public List<XMLStructure> getContent() Implements javax.xml.crypto.dsig.XMLObject.getContent. Doc from javax.xml.crypto.dsig.XMLObject.getContent. Returns an `unmodifiable list` of `XMLStructure`s 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 `javax.xml.crypto.dsig.SignatureProperties`). Annotations @Override

public List<XMLStructure> getContent()

Implements javax.xml.crypto.dsig.XMLObject.getContent.

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

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 javax.xml.crypto.dsig.SignatureProperties).

Annotations

@Override

getEncoding back to summary

getEncoding	back to summary
public String getEncoding() Implements javax.xml.crypto.dsig.XMLObject.getEncoding. Doc from javax.xml.crypto.dsig.XMLObject.getEncoding. Returns the encoding URI of this `XMLObject`. The encoding URI identifies the method by which the object is encoded. Annotations @Override

public String getEncoding()

Implements javax.xml.crypto.dsig.XMLObject.getEncoding.

Doc from javax.xml.crypto.dsig.XMLObject.getEncoding.

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

Annotations

@Override

getId back to summary

getId	back to summary
public String getId() Implements javax.xml.crypto.dsig.XMLObject.getId. Doc from javax.xml.crypto.dsig.XMLObject.getId. Returns the Id of this `XMLObject`. Annotations @Override

public String getId()

Implements javax.xml.crypto.dsig.XMLObject.getId.

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

Returns the Id of this XMLObject.

Annotations

@Override

getMimeType back to summary

getMimeType	back to summary
public String getMimeType() Implements javax.xml.crypto.dsig.XMLObject.getMimeType. Doc from javax.xml.crypto.dsig.XMLObject.getMimeType. 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). Annotations @Override

public String getMimeType()

Implements javax.xml.crypto.dsig.XMLObject.getMimeType.

Doc from javax.xml.crypto.dsig.XMLObject.getMimeType.

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

Annotations

@Override

hashCode back to summary

hashCode	back 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

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

marshal	back 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

marshal

back 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

public final Class DOMXMLObject

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail