public final Class ModuleLink

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Annotations

@Override

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

Returns a link for empty packages in a given module.

The same link can be used for multiple packages in the same module.

Parameters

moduleName:String

the name of the module in which this package exits.

isPreview:boolean

whether the associated package is defined for preview mode.

Returns a link for non-empty packages (those with resources) in a given module.

The same link can be used for multiple packages in the same module.

Parameters

moduleName:String

the name of the module in which this package exits.

isPreview:boolean

whether the associated package is defined for preview mode.

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

Returns whether the package associated with this module link has a preview version (empty or otherwise) in this link's module.

Returns whether the package associated with this link contains resources in its module.

An invariant of the module system is that while a package may exist under many modules, it only has resources in one.

Returns whether this module link exists only in preview mode.

Merges two links for the same module (combining their flags).

Returns the module name of this link.

Reads the content buffer of a package subdirectory to return a sequence of module name offsets in the jimage.

Package subdirectories store their entries using pairs of integers in an interleaved buffer:

    ...
    [ entry-N flags ]
    [ entry-N name offset ]
    [ entry-(N+1) flags ]
    [ entry-(N+1) name offset ]
    ...

Entry flags control whether an entry name should be included by the returned iterator, depending on the given include-flags.

Parameters

buffer:IntBuffer

the content buffer of an ImageLocation with type PACKAGES_DIR.

includeNormal:boolean

whether to include name offsets for modules present in normal (non-preview) mode.

includePreview:boolean

whether to include name offsets for modules present in preview mode.

Returns:Iterator<Integer>

an iterator of module name offsets.

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.

Annotations

@Override

Writes a list of module links to a given buffer. The given entry list is checked carefully to ensure the written buffer will be valid.

Entries are written in order, taking two integer slots per entry as [<flags>, <encoded-name>].

Parameters

links:List<ModuleLink>

the module links to write, correctly ordered.

buffer:IntBuffer

destination buffer.

nameEncoder:Function<String, Integer>

encoder for module names.

Exceptions

IllegalArgumentException:

in the link entries are invalid in any way.