Top Description Inners Fields Constructors Methods
jdk.internal.module

public Class ModuleReferenceImpl

extends ModuleReference
Class Inheritance
Imports
java.io.IOException, .UncheckedIOException, java.lang.module.ModuleDescriptor, .ModuleReader, .ModuleReference, java.net.URI, java.util.Objects, java.util.function.Supplier

A ModuleReference implementation that supports referencing a module that is patched and/or can be tied to other modules by means of hashes.

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static record

Field Summary

Modifier and TypeField and Description
private ModuleReferenceImpl.CachedHash
private int
private final ModuleHashes.HashSupplier
private final URI
private final ModuleResolution
private final ModulePatcher
private final Supplier<ModuleReader>
private final ModuleHashes
private final ModuleTarget

Constructor Summary

AccessConstructor and Description
public
ModuleReferenceImpl(ModuleDescriptor descriptor, URI location, Supplier<ModuleReader> readerSupplier, ModulePatcher patcher, ModuleTarget target, ModuleHashes recordedHashes, ModuleHashes.HashSupplier hasher, ModuleResolution moduleResolution)

Constructs a new instance of this class.

Method Summary

Modifier and TypeMethod and Description
public byte[]
computeHash(String algorithm)

Computes the hash of this module.

public boolean
equals(Object
the reference object with which to compare.
ob
)

Overrides java.lang.Object.equals.

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

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

pack-priv ModuleHashes.HashSupplier
hasher()

Returns the supplier that computes the hash of this module.

public boolean
isPatched()

Returns true if this module has been patched via --patch-module.

public ModuleResolution
moduleResolution()

Returns the ModuleResolution flags.

public ModuleTarget
moduleTarget()

Returns the ModuleTarget or null if the no target platform.

public ModuleReader
open()

Implements abstract java.lang.module.ModuleReference.open.

Opens the module content for reading.

public ModuleHashes
recordedHashes()

Returns the hashes recorded in this module or null if there are no hashes recorded.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.module.ModuleReference:
descriptorlocation

Field Detail

cachedHashback to summary
private ModuleReferenceImpl.CachedHash cachedHash
hashback to summary
private int hash
hasherback to summary
private final ModuleHashes.HashSupplier hasher
locationback to summary
private final URI location

Hides java.lang.module.ModuleReference.location.

moduleResolutionback to summary
private final ModuleResolution moduleResolution
patcherback to summary
private final ModulePatcher patcher
readerSupplierback to summary
private final Supplier<ModuleReader> readerSupplier
recordedHashesback to summary
private final ModuleHashes recordedHashes
targetback to summary
private final ModuleTarget target

Constructor Detail

ModuleReferenceImplback to summary
public ModuleReferenceImpl(ModuleDescriptor descriptor, URI location, Supplier<ModuleReader> readerSupplier, ModulePatcher patcher, ModuleTarget target, ModuleHashes recordedHashes, ModuleHashes.HashSupplier hasher, ModuleResolution moduleResolution)

Constructs a new instance of this class.

Method Detail

computeHashback to summary
public byte[] computeHash(String algorithm)

Computes the hash of this module. Returns null if the hash cannot be computed.

Exceptions
UncheckedIOException:
if an I/O error occurs
equalsback to summary
public boolean equals(Object ob)

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
ob: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
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
hasherback to summary
pack-priv ModuleHashes.HashSupplier hasher()

Returns the supplier that computes the hash of this module.

isPatchedback to summary
public boolean isPatched()

Returns true if this module has been patched via --patch-module.

moduleResolutionback to summary
public ModuleResolution moduleResolution()

Returns the ModuleResolution flags.

moduleTargetback to summary
public ModuleTarget moduleTarget()

Returns the ModuleTarget or null if the no target platform.

openback to summary
public ModuleReader open() throws IOException

Implements abstract java.lang.module.ModuleReference.open.

Doc from java.lang.module.ModuleReference.open.

Opens the module content for reading.

Returns:ModuleReader

A ModuleReader to read the module

Annotations
@Override
Exceptions
IOException:
If an I/O error occurs
recordedHashesback to summary
public ModuleHashes recordedHashes()

Returns the hashes recorded in this module or null if there are no hashes recorded.

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override
jdk.internal.module back to summary

private final Record ModuleReferenceImpl.CachedHash

extends Record
Class Inheritance
Record Components
hash:byte[] 
algorithm:String

Field Summary

Modifier and TypeField and Description
private final String
algorithm

Record Component accessed by algorithm().

private final byte[]
hash

Record Component accessed by hash().

Constructor Summary

AccessConstructor and Description
private
CachedHash(byte[] hash, String algorithm)

Method Summary

Modifier and TypeMethod and Description
public String
algorithm()

Record Component getter of algorithm.

public final boolean
equals(Object
the reference object with which to compare.
o
)

Implements abstract java.lang.Record.equals.

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

public byte[]
hash()

Record Component getter of hash.

public final int
hashCode()

Implements abstract java.lang.Record.hashCode.

Returns a hash code value for the record.

public final String
toString()

Implements abstract java.lang.Record.toString.

Returns a string representation of the record.

Field Detail

algorithmback to summary
private final String algorithm

Record Component accessed by algorithm().

hashback to summary
private final byte[] hash

Record Component accessed by hash().

Constructor Detail

CachedHashback to summary
private CachedHash(byte[] hash, String algorithm)

Method Detail

algorithmback to summary
public String algorithm()

Record Component getter of algorithm.

equalsback to summary
public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());
then it must be the case that r.equals(copy).
Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this record is equal to the argument; false otherwise.

hashback to summary
public byte[] hash()

Record Component getter of hash.

hashCodeback to summary
public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

Returns:int

a hash code value for this record.

toStringback to summary
public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

Returns:String

a string representation of the object.