OpenJDK 27 · java.lang.classfile.attribute.ModuleHashesAttribute

Models the ModuleHashes attribute, which appears on classes that represent module descriptors to capture the hashes of a set of co-delivered modules.

The specification of the ModuleHashes attribute is:

 ModuleHashes_attribute {
  // index to CONSTANT_utf8_info structure in constant pool representing
  // the string "ModuleHashes"
  u2 attribute_name_index;
  u4 attribute_length;

  // index to CONSTANT_utf8_info structure with algorithm name
  u2 algorithm_index;

  // the number of entries in the hashes table
  u2 hashes_count;
  {   u2 module_name_index (index to CONSTANT_Module_info structure)
      u2 hash_length;
      u1 hash[hash_length];
  } hashes[hashes_count];

}

This attribute only appears on classes, and does not permit multiple instances in a class. It has a data dependency on the constant pool.

This attribute is not predefined in the Java SE Platform. This is a JDK-specific nonstandard attribute produced by the jdk.jlink module, which defines the jlink and jmod tools.

Method Summary

Modifier and Type	Method and Description
public Utf8Entry	Returns: the algorithm name used to compute the hash algorithm() Returns the algorithm name used to compute the hash.
public List<ModuleHashInfo>	Returns: the hash information about related modules hashes() Returns the hash information about related modules.
public static ModuleHashesAttribute	Returns: a `ModuleHashes` attribute of(String the hashing algorithm algorithm, List<ModuleHashInfo> the hash descriptions hashes) Returns a `ModuleHashes` attribute.
public static ModuleHashesAttribute	Returns: a `ModuleHashes` attribute of(String the hashing algorithm algorithm, ModuleHashInfo... the hash descriptions hashes) Returns a `ModuleHashes` attribute.
public static ModuleHashesAttribute	Returns: a `ModuleHashes` attribute of(Utf8Entry the hashing algorithm algorithm, List<ModuleHashInfo> the hash descriptions hashes) Returns a `ModuleHashes` attribute.
public static ModuleHashesAttribute	Returns: a `ModuleHashes` attribute of(Utf8Entry the hashing algorithm algorithm, ModuleHashInfo... the hash descriptions hashes) Returns a `ModuleHashes` attribute.

Inherited from java.lang.classfile.Attribute:: attributeMapper attributeName

Method Detail

algorithm	back to summary
public Utf8Entry algorithm() Returns the algorithm name used to compute the hash. Returns:Utf8Entry the algorithm name used to compute the hash

algorithm

back to summary

public Utf8Entry algorithm()

Returns the algorithm name used to compute the hash.

Returns:Utf8Entry: the algorithm name used to compute the hash

hashes	back to summary
public List<ModuleHashInfo> hashes() Returns the hash information about related modules. Returns:List<ModuleHashInfo> the hash information about related modules

hashes

back to summary

public List<ModuleHashInfo> hashes()

Returns the hash information about related modules.

Returns:List<ModuleHashInfo>: the hash information about related modules

of back to summary

of	back to summary
public static ModuleHashesAttribute of(String algorithm, List<ModuleHashInfo> hashes) Returns a `ModuleHashes` attribute. Parameters algorithm:String the hashing algorithm hashes:List<ModuleHashInfo> the hash descriptions Returns:ModuleHashesAttribute a `ModuleHashes` attribute Exceptions IllegalArgumentException: if the number of descriptions exceeds the limit of `u2`

public static ModuleHashesAttribute of(String algorithm, List<ModuleHashInfo> hashes)

Returns a ModuleHashes attribute.

Parameters

algorithm:String: the hashing algorithm
hashes:List<ModuleHashInfo>: the hash descriptions

Returns:ModuleHashesAttribute

a ModuleHashes attribute

Exceptions

IllegalArgumentException:: if the number of descriptions exceeds the limit of u2

of back to summary

of	back to summary
public static ModuleHashesAttribute of(String algorithm, ModuleHashInfo... hashes) Returns a `ModuleHashes` attribute. Parameters algorithm:String the hashing algorithm hashes:ModuleHashInfo[] the hash descriptions Returns:ModuleHashesAttribute a `ModuleHashes` attribute Exceptions IllegalArgumentException: if the number of descriptions exceeds the limit of `u2`

public static ModuleHashesAttribute of(String algorithm, ModuleHashInfo... hashes)

Returns a ModuleHashes attribute.

Parameters

algorithm:String: the hashing algorithm
hashes:ModuleHashInfo[]: the hash descriptions

Returns:ModuleHashesAttribute

a ModuleHashes attribute

Exceptions

IllegalArgumentException:: if the number of descriptions exceeds the limit of u2

of back to summary

of	back to summary
public static ModuleHashesAttribute of(Utf8Entry algorithm, List<ModuleHashInfo> hashes) Returns a `ModuleHashes` attribute. Parameters algorithm:Utf8Entry the hashing algorithm hashes:List<ModuleHashInfo> the hash descriptions Returns:ModuleHashesAttribute a `ModuleHashes` attribute Exceptions IllegalArgumentException: if the number of descriptions exceeds the limit of `u2`

public static ModuleHashesAttribute of(Utf8Entry algorithm, List<ModuleHashInfo> hashes)

Returns a ModuleHashes attribute.

Parameters

algorithm:Utf8Entry: the hashing algorithm
hashes:List<ModuleHashInfo>: the hash descriptions

Returns:ModuleHashesAttribute

a ModuleHashes attribute

Exceptions

IllegalArgumentException:: if the number of descriptions exceeds the limit of u2

of back to summary

of	back to summary
public static ModuleHashesAttribute of(Utf8Entry algorithm, ModuleHashInfo... hashes) Returns a `ModuleHashes` attribute. Parameters algorithm:Utf8Entry the hashing algorithm hashes:ModuleHashInfo[] the hash descriptions Returns:ModuleHashesAttribute a `ModuleHashes` attribute Exceptions IllegalArgumentException: if the number of descriptions exceeds the limit of `u2`

public static ModuleHashesAttribute of(Utf8Entry algorithm, ModuleHashInfo... hashes)

Returns a ModuleHashes attribute.

Parameters

algorithm:Utf8Entry: the hashing algorithm
hashes:ModuleHashInfo[]: the hash descriptions

Returns:ModuleHashesAttribute

a ModuleHashes attribute

Exceptions

IllegalArgumentException:: if the number of descriptions exceeds the limit of u2

public sealed Interface ModuleHashesAttribute

Method Summary

Method Detail