Class ModuleDescriptor

Returns the module name.

Returns the set of module modifiers.

Returns true if this is an open module.

This method is equivalent to testing if the set of modifiers contains the OPEN modifier.

Returns true if this is an automatic module.

This method is equivalent to testing if the set of modifiers contains the AUTOMATIC modifier.

Returns the set of Requires objects representing the module dependences.

The set includes a dependency on "java.base" when this module is not named "java.base". If this module is an automatic module then it does not have a dependency on any module other than "java.base".

Returns the set of Exports objects representing the exported packages.

If this module is an automatic module then the set of exports is empty.

Returns the set of Opens objects representing the open packages.

If this module is an open module or an automatic module then the set of open packages is empty.

Returns the set of service dependences.

If this module is an automatic module then the set of service dependences is empty.

Returns the set of Provides objects representing the services that the module provides.

Returns the module version.

Returns the string with the possibly-unparseable version of the module.

Returns a string containing the module name and, if present, its version.

Returns the module main class.

The set of packages includes all exported and open packages, as well as the packages of any service providers, and the package for the main class.

Two ModuleDescriptor objects are compared by comparing their module names lexicographically. Where the module names are equal then the module versions are compared. When comparing the module versions then a module descriptor with a version is considered to succeed a module descriptor that does not have a version. If both versions are unparseable then the raw version strings are compared lexicographically. Where the module names are equal and the versions are equal (or not present in both), then the set of modifiers are compared. Sets of modifiers are compared by comparing a binary value computed for each set. If a modifier is present in the set then the bit at the position of its ordinal is 1 in the binary value, otherwise 0. If the two set of modifiers are also equal then the other components of the module descriptors are compared in a manner that is consistent with equals.

If the given object is not a ModuleDescriptor then this method returns false. Two module descriptors are equal if each of their corresponding components is equal.

This method satisfies the general contract of the Object.equals method.

The hash code is based upon the components of the module descriptor, and satisfies the general contract of the Object.hashCode method.

Returns a string describing the module.

The builder for an open module cannot be used to declare any open packages.

The builder for an automatic module cannot be used to declare module or service dependences. It also cannot be used to declare any exported or open packages.

If the descriptor encoded in the input stream does not indicate a set of packages in the module then the packageFinder will be invoked. The set of packages that the packageFinder returns must include all the packages that the module exports, opens, as well as the packages of the service implementations that the module provides, and the package of the main class (if the module has a main class). If the packageFinder throws an UncheckedIOException then IOException cause will be re-thrown.

If there are bytes following the module descriptor then it is implementation specific as to whether those bytes are read, ignored, or reported as an InvalidModuleDescriptorException. If this method fails with an InvalidModuleDescriptorException or IOException then it may do so after some, but not all, bytes have been read from the input stream. It is strongly recommended that the stream be promptly closed and discarded if an exception occurs.

If the descriptor encoded in the byte buffer does not indicate a set of packages in the module then the packageFinder will be invoked. The set of packages that the packageFinder returns must include all the packages that the module exports, opens, as well as the packages of the service implementations that the module provides, and the package of the main class (if the module has a main class). If the packageFinder throws an UncheckedIOException then IOException cause will be re-thrown.

The module descriptor is read from the buffer starting at index p, where p is the buffer's position when this method is invoked. Upon return the buffer's position will be equal to p + n where n is the number of bytes read from the buffer.

If there are bytes following the module descriptor then it is implementation specific as to whether those bytes are read, ignored, or reported as an InvalidModuleDescriptorException. If this method fails with an InvalidModuleDescriptorException then it may do so after some, but not all, bytes have been read.