archive/jdk
1
0
Fork 0
mirror of https://github.com/openjdk/jdk.git synced 2025-08-28 15:24:43 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

8256993: Clarify Package::isSealed javadoc about package sealing vs sealed class or interface

Browse source 
Reviewed-by: alanb
This commit is contained in:
Mandy Chung 2020-11-24 21:18:46 +00:00
parent 1b7a61ff4a
commit 3c230b8ac5
1 changed files with 16 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

17
src/java.base/share/classes/java/lang/Package.java
View file

@ -53,7 +53,7 @@ import jdk.internal.reflect.Reflection;
* {@code Package} is compatible with a particular specification version * {@code Package} is compatible with a particular specification version
* by using the {@link #isCompatibleWith Package.isCompatibleWith(String)} * by using the {@link #isCompatibleWith Package.isCompatibleWith(String)}
* method. In addition, information about the actual classes that make up the * method. In addition, information about the actual classes that make up the
* run-time package can be provided when the Package is defined. * run-time package can be provided when the {@code Package} is defined.
* This information consists of an implementation title, version, and vendor * This information consists of an implementation title, version, and vendor
* (indicating the supplier of the classes). * (indicating the supplier of the classes).
* <p> * <p>
@ -221,7 +221,15 @@ public class Package extends NamedPackage implements java.lang.reflect.Annotated
/** /**
* Returns true if this package is sealed. * Returns true if this package is sealed.
* *
* @apiNote
* <a href="{@docRoot}/../specs/jar/jar.html#package-sealing">Package sealing</a>
* has no relationship with {@linkplain Class#isSealed() sealed classes or interfaces}.
* Package sealing is specific to JAR files defined for classes in an unnamed module.
* See the {@link Package Package} class specification for details
* how a {@code Package} is defined as sealed package.
*
* @return true if the package is sealed, false otherwise * @return true if the package is sealed, false otherwise
*
*/ */
public boolean isSealed() { public boolean isSealed() {
return module().isNamed() || versionInfo.sealBase != null; return module().isNamed() || versionInfo.sealBase != null;
@ -231,6 +239,13 @@ public class Package extends NamedPackage implements java.lang.reflect.Annotated
* Returns true if this package is sealed with respect to the specified * Returns true if this package is sealed with respect to the specified
* code source {@code url}. * code source {@code url}.
* *
* @apiNote
* <a href="{@docRoot}/../specs/jar/jar.html#package-sealing">Package sealing</a>
* has no relationship with {@linkplain Class#isSealed() sealed classes or interfaces}.
* Package sealing is specific to JAR files defined for classes in an unnamed module.
* See the {@link Package Package} class specification for details
* how a {@code Package} is defined as sealed package.
*
* @param url the code source URL * @param url the code source URL
* @return true if this package is sealed with respect to the given {@code url} * @return true if this package is sealed with respect to the given {@code url}
*/ */