OpenJDK 1.23 · java.lang.Package · APIdia, the JavaDoc alternative

Represents metadata about a run-time package associated with a class loader. Metadata includes annotations, versioning, and sealing.

Annotations for the run-time package are read from package-info.class at the same code source as classes in the run-time package.

The set of classes that make up the run-time package may implement a particular specification. The specification title, version, and vendor (indicating the owner/maintainer of the specification) can be provided when the Package is defined. An application can ask if the Package is compatible with a particular specification version by using the Package.isCompatibleWith(String) method. In addition, information about the actual classes that make up the run-time package can be provided when the Package is defined. This information consists of an implementation title, version, and vendor (indicating the supplier of the classes).

A Package may be explicitly defined with the ClassLoader#definePackage(String, String, String, String, String, String, String, URL) method. The caller supplies the specification and implementation titles, versions, and vendors. The caller also indicates whether the package is sealed. If a Package is not explicitly defined for a run-time package when a class in that run-time package is defined, then a Package is automatically defined by the class's defining class loader, as follows.

A Package automatically defined for classes in a named module has the following properties:

The name of the package is derived from the binary names of the classes. Since classes in a named module must be in a named package, the derived name is never empty.
The package is sealed with the module location as the code source, if known.
The specification and implementation titles, versions, and vendors are unspecified.
Any annotations on the package are read from package-info.class as specified above.

A Package automatically defined for classes in an unnamed module has the following properties:

The name of the package is either "" (for classes in an unnamed package) or derived from the binary names of the classes (for classes in a named package).
The package is not sealed.
The specification and implementation titles, versions, and vendors are unspecified.
Any annotations on the package are read from package-info.class as specified above.

A Package can be obtained with the Package.getPackage(String) and ClassLoader.getDefinedPackage(String) methods. Every Package defined by a class loader can be obtained with the Package.getPackages() and ClassLoader#getDefinedPackages methods.

Modifier and Type	Class and Description
pack-priv static class	Package.VersionInfo

Field Summary

Modifier and Type	Field and Description
private Class<?>	packageInfo
private final Package.VersionInfo	versionInfo

Access	Constructor and Description
pack-priv	Package(String the name of the package name, String the title of the specification spectitle, String the version of the specification specversion, String the organization that maintains the specification specvendor, String the title of the implementation impltitle, String the version of the implementation implversion, String the organization that maintains the implementation implvendor, URL code source where this Package comes from sealbase, ClassLoader defining class loader loader) Construct a package instance for an unnamed module with the specified version information.
pack-priv	Package(String name, Module module)

Method Summary

Modifier and Type	Method and Description
public <A extends Annotation> A	getAnnotation(Class<A> the Class object corresponding to the annotation type annotationClass) Implements java.lang.reflect.AnnotatedElement.getAnnotation. Returns this element's annotation for the specified type if such an annotation is present, else null.
public Annotation[]	getAnnotations() Implements java.lang.reflect.AnnotatedElement.getAnnotations. Returns annotations that are present on this element.
public <A extends Annotation> A[]	getAnnotationsByType(Class<A> the Class object corresponding to the annotation type annotationClass) Overrides default java.lang.reflect.AnnotatedElement.getAnnotationsByType. Returns annotations that are associated with this element.
public <A extends Annotation> A	getDeclaredAnnotation(Class<A> the Class object corresponding to the annotation type annotationClass) Overrides default java.lang.reflect.AnnotatedElement.getDeclaredAnnotation. Returns this element's annotation for the specified type if such an annotation is directly present, else null.
public Annotation[]	getDeclaredAnnotations() Implements java.lang.reflect.AnnotatedElement.getDeclaredAnnotations. Returns annotations that are directly present on this element.
public <A extends Annotation> A[]	getDeclaredAnnotationsByType(Class<A> the Class object corresponding to the annotation type annotationClass) Overrides default java.lang.reflect.AnnotatedElement.getDeclaredAnnotationsByType. Returns this element's annotation(s) for the specified type if such annotations are either directly present or indirectly present.
public String	Returns: the title of the implementation, `null` is returned if it is not known. getImplementationTitle() Return the title of this package.
public String	Returns: the vendor that implemented this package, `null` is returned if it is not known. getImplementationVendor() Returns the vendor that implemented this package, `null` is returned if it is not known.
public String	Returns: the version of the implementation, `null` is returned if it is not known. getImplementationVersion() Return the version of this implementation.
public String	Returns: The fully-qualified name of this package as defined in section 6.5.3 of The Java Language Specification, for example, `java.lang` getName() Return the name of this package.
public static Package	Returns: The `Package` of the given name defined by the caller's class loader or its ancestors, or `null` if not found. getPackage(String A package name, such as "`java.lang`". name) Deprecated since 9. If multiple class loaders delegate to each other and define classes with the same package name, and one such loader relies on the lookup behavior of `getPackage` to return a `Package` from a parent loader, then the properties exposed by the `Package` may not be as expected in the rest of the program. Finds a package by name in the caller's class loader and its ancestors.
private Class<?>	getPackageInfo()
public static Package[]	Returns: The array of `Package` objects defined by this class loader and its ancestors getPackages() Returns all of the `Package`s defined by the caller's class loader and its ancestors.
public String	Returns: the specification title, `null` is returned if it is not known. getSpecificationTitle() Return the title of the specification that this package implements.
public String	Returns: the specification vendor, `null` is returned if it is not known. getSpecificationVendor() Return the name of the organization, vendor, or company that owns and maintains the specification of the classes that implement this package.
public String	Returns: the specification version, `null` is returned if it is not known. getSpecificationVersion() Returns the version number of the specification that this package implements.
public int	Returns: the hash code computed from the package name. hashCode() Overrides java.lang.Object.hashCode. Return the hash code computed from the package name.
public boolean	isAnnotationPresent(Class<? extends Annotation> the Class object corresponding to the annotation type annotationClass) Overrides default java.lang.reflect.AnnotatedElement.isAnnotationPresent. Returns true if an annotation for the specified type is present on this element, else false.
public boolean	Returns: true if this package's version number is greater than or equal to the desired version number isCompatibleWith(String the version string of the desired version. desired) Compare this package's specification version with a desired version.
public boolean	Returns: true if the package is sealed, false otherwise isSealed() Returns true if this package is sealed.
public boolean	Returns: true if this package is sealed with respect to the given `url` isSealed(URL the code source URL url) Returns true if this package is sealed with respect to the specified code source `url`.
public String	Returns: the string representation of the package. toString() Overrides java.lang.Object.toString. Returns the string representation of this Package.

Inherited from java.lang.NamedPackage:: location module packageName toPackage

Field Detail

packageInfo	back to summary
private Class<?> packageInfo

versionInfo	back to summary
private final Package.VersionInfo versionInfo

Constructor Detail

Package	back to summary
pack-priv Package(String name, String spectitle, String specversion, String specvendor, String impltitle, String implversion, String implvendor, URL sealbase, ClassLoader loader) Construct a package instance for an unnamed module with the specified version information. API Note This method should not be called to define a Package for named module. Parameters name:String the name of the package spectitle:String the title of the specification specversion:String the version of the specification specvendor:String the organization that maintains the specification impltitle:String the title of the implementation implversion:String the version of the implementation implvendor:String the organization that maintains the implementation sealbase:URL code source where this Package comes from loader:ClassLoader defining class loader

Package

back to summary

pack-priv Package(String name, String spectitle, String specversion, String specvendor, String impltitle, String implversion, String implvendor, URL sealbase, ClassLoader loader)

Construct a package instance for an unnamed module with the specified version information.

API Note

This method should not be called to define a Package for named module.

Parameters

name:String: the name of the package
spectitle:String: the title of the specification
specversion:String: the version of the specification
specvendor:String: the organization that maintains the specification
impltitle:String: the title of the implementation
implversion:String: the version of the implementation
implvendor:String: the organization that maintains the implementation
sealbase:URL: code source where this Package comes from
loader:ClassLoader: defining class loader

Package	back to summary
pack-priv Package(String name, Module module)

Method Detail

getAnnotation	back to summary
public <A extends Annotation> A getAnnotation(Class<A> annotationClass) Implements java.lang.reflect.AnnotatedElement.getAnnotation. Doc from java.lang.reflect.AnnotatedElement.getAnnotation. Returns this element's annotation for the specified type if such an annotation is present, else null. Note that any annotation returned by this method is a declaration annotation. Parameters <A> the type of the annotation to query for and return if present annotationClass:Class<A> the Class object corresponding to the annotation type Returns:A this element's annotation for the specified annotation type if present on this element, else null Annotations @Override Exceptions NullPointerException: if the given annotation class is null Since 1.5

getAnnotation

back to summary

public <A extends Annotation> A getAnnotation(Class<A> annotationClass)

Implements java.lang.reflect.AnnotatedElement.getAnnotation.

Doc from java.lang.reflect.AnnotatedElement.getAnnotation.

Returns this element's annotation for the specified type if such an annotation is present, else null.

Note that any annotation returned by this method is a declaration annotation.

Parameters

<A>: the type of the annotation to query for and return if present
annotationClass:Class<A>: the Class object corresponding to the annotation type

Returns:A

this element's annotation for the specified annotation type if present on this element, else null

Annotations

@Override

Exceptions

NullPointerException:: if the given annotation class is null

Since

1.5

getAnnotations	back to summary
public Annotation[] getAnnotations() Implements java.lang.reflect.AnnotatedElement.getAnnotations. Doc from java.lang.reflect.AnnotatedElement.getAnnotations. Returns annotations that are present on this element. If there are no annotations present on this element, the return value is an array of length 0. The caller of this method is free to modify the returned array; it will have no effect on the arrays returned to other callers. Note that any annotations returned by this method are declaration annotations. Returns:Annotation[] annotations present on this element Annotations @Override Since 1.5

getAnnotations

back to summary

public Annotation[] getAnnotations()

Implements java.lang.reflect.AnnotatedElement.getAnnotations.

Doc from java.lang.reflect.AnnotatedElement.getAnnotations.

Returns annotations that are present on this element. If there are no annotations present on this element, the return value is an array of length 0. The caller of this method is free to modify the returned array; it will have no effect on the arrays returned to other callers.

Note that any annotations returned by this method are declaration annotations.

Returns:Annotation[]

annotations present on this element

Annotations

@Override

Since

1.5

getAnnotationsByType back to summary

getAnnotationsByType	back to summary
public <A extends Annotation> A[] getAnnotationsByType(Class<A> annotationClass) Overrides default java.lang.reflect.AnnotatedElement.getAnnotationsByType. Doc from java.lang.reflect.AnnotatedElement.getAnnotationsByType. Returns annotations that are associated with this element. If there are no annotations associated with this element, the return value is an array of length 0. The difference between this method and `getAnnotation(Class)` is that this method detects if its argument is a repeatable annotation type (JLS 9.6), and if so, attempts to find one or more annotations of that type by "looking through" a container annotation. The caller of this method is free to modify the returned array; it will have no effect on the arrays returned to other callers. Note that any annotations returned by this method are declaration annotations. Parameters <A> the type of the annotation to query for and return if present annotationClass:Class<A> the Class object corresponding to the annotation type Returns:A[] all this element's annotations for the specified annotation type if associated with this element, else an array of length zero Annotations @Override Exceptions NullPointerException: if the given annotation class is null Since 1.8

public <A extends Annotation> A[] getAnnotationsByType(Class<A> annotationClass)

Overrides default java.lang.reflect.AnnotatedElement.getAnnotationsByType.

Doc from java.lang.reflect.AnnotatedElement.getAnnotationsByType.

Returns annotations that are associated with this element. If there are no annotations associated with this element, the return value is an array of length 0. The difference between this method and getAnnotation(Class) is that this method detects if its argument is a repeatable annotation type (JLS 9.6), and if so, attempts to find one or more annotations of that type by "looking through" a container annotation. The caller of this method is free to modify the returned array; it will have no effect on the arrays returned to other callers.

Note that any annotations returned by this method are declaration annotations.

Parameters

<A>: the type of the annotation to query for and return if present
annotationClass:Class<A>: the Class object corresponding to the annotation type

Returns:A[]

all this element's annotations for the specified annotation type if associated with this element, else an array of length zero

Annotations

@Override

Exceptions

NullPointerException:: if the given annotation class is null

Since

1.8

getDeclaredAnnotation	back to summary
public <A extends Annotation> A getDeclaredAnnotation(Class<A> annotationClass) Overrides default java.lang.reflect.AnnotatedElement.getDeclaredAnnotation. Doc from java.lang.reflect.AnnotatedElement.getDeclaredAnnotation. Returns this element's annotation for the specified type if such an annotation is directly present, else null. This method ignores inherited annotations. (Returns null if no annotations are directly present on this element.) Note that any annotation returned by this method is a declaration annotation. Parameters <A> the type of the annotation to query for and return if directly present annotationClass:Class<A> the Class object corresponding to the annotation type Returns:A this element's annotation for the specified annotation type if directly present on this element, else null Annotations @Override Exceptions NullPointerException: if the given annotation class is null Since 1.8

getDeclaredAnnotation

back to summary

public <A extends Annotation> A getDeclaredAnnotation(Class<A> annotationClass)

Overrides default java.lang.reflect.AnnotatedElement.getDeclaredAnnotation.

Doc from java.lang.reflect.AnnotatedElement.getDeclaredAnnotation.

Returns this element's annotation for the specified type if such an annotation is directly present, else null. This method ignores inherited annotations. (Returns null if no annotations are directly present on this element.)

Note that any annotation returned by this method is a declaration annotation.

Parameters

<A>: the type of the annotation to query for and return if directly present
annotationClass:Class<A>: the Class object corresponding to the annotation type

Returns:A

this element's annotation for the specified annotation type if directly present on this element, else null

Annotations

@Override

Exceptions

NullPointerException:: if the given annotation class is null

Since

1.8

getDeclaredAnnotations	back to summary
public Annotation[] getDeclaredAnnotations() Implements java.lang.reflect.AnnotatedElement.getDeclaredAnnotations. Doc from java.lang.reflect.AnnotatedElement.getDeclaredAnnotations. Returns annotations that are directly present on this element. This method ignores inherited annotations. If there are no annotations directly present on this element, the return value is an array of length 0. The caller of this method is free to modify the returned array; it will have no effect on the arrays returned to other callers. Note that any annotations returned by this method are declaration annotations. Returns:Annotation[] annotations directly present on this element Annotations @Override Since 1.5

getDeclaredAnnotations

back to summary

public Annotation[] getDeclaredAnnotations()

Implements java.lang.reflect.AnnotatedElement.getDeclaredAnnotations.

Doc from java.lang.reflect.AnnotatedElement.getDeclaredAnnotations.

Returns annotations that are directly present on this element. This method ignores inherited annotations. If there are no annotations directly present on this element, the return value is an array of length 0. The caller of this method is free to modify the returned array; it will have no effect on the arrays returned to other callers.

Note that any annotations returned by this method are declaration annotations.

Returns:Annotation[]

annotations directly present on this element

Annotations

@Override

Since

1.5

getDeclaredAnnotationsByType back to summary

getDeclaredAnnotationsByType	back to summary
public <A extends Annotation> A[] getDeclaredAnnotationsByType(Class<A> annotationClass) Overrides default java.lang.reflect.AnnotatedElement.getDeclaredAnnotationsByType. Doc from java.lang.reflect.AnnotatedElement.getDeclaredAnnotationsByType. Returns this element's annotation(s) for the specified type if such annotations are either directly present or indirectly present. This method ignores inherited annotations. If there are no specified annotations directly or indirectly present on this element, the return value is an array of length 0. The difference between this method and `getDeclaredAnnotation(Class)` is that this method detects if its argument is a repeatable annotation type (JLS 9.6), and if so, attempts to find one or more annotations of that type by "looking through" a container annotation if one is present. The caller of this method is free to modify the returned array; it will have no effect on the arrays returned to other callers. Parameters <A> the type of the annotation to query for and return if directly or indirectly present annotationClass:Class<A> the Class object corresponding to the annotation type Returns:A[] all this element's annotations for the specified annotation type if directly or indirectly present on this element, else an array of length zero Annotations @Override Exceptions NullPointerException: if the given annotation class is null Since 1.8

public <A extends Annotation> A[] getDeclaredAnnotationsByType(Class<A> annotationClass)

Overrides default java.lang.reflect.AnnotatedElement.getDeclaredAnnotationsByType.

Doc from java.lang.reflect.AnnotatedElement.getDeclaredAnnotationsByType.

Returns this element's annotation(s) for the specified type if such annotations are either directly present or indirectly present. This method ignores inherited annotations. If there are no specified annotations directly or indirectly present on this element, the return value is an array of length 0. The difference between this method and getDeclaredAnnotation(Class) is that this method detects if its argument is a repeatable annotation type (JLS 9.6), and if so, attempts to find one or more annotations of that type by "looking through" a container annotation if one is present. The caller of this method is free to modify the returned array; it will have no effect on the arrays returned to other callers.

Parameters

<A>: the type of the annotation to query for and return if directly or indirectly present
annotationClass:Class<A>: the Class object corresponding to the annotation type

Returns:A[]

all this element's annotations for the specified annotation type if directly or indirectly present on this element, else an array of length zero

Annotations

@Override

Exceptions

NullPointerException:: if the given annotation class is null

Since

1.8

getImplementationTitle back to summary

getImplementationTitle	back to summary
public String getImplementationTitle() Return the title of this package. Returns:String the title of the implementation, `null` is returned if it is not known.

public String getImplementationTitle()

Return the title of this package.

Returns:String: the title of the implementation, null is returned if it is not known.

getImplementationVendor back to summary

getImplementationVendor	back to summary
public String getImplementationVendor() Returns the vendor that implemented this package, `null` is returned if it is not known. Returns:String the vendor that implemented this package, `null` is returned if it is not known.

public String getImplementationVendor()

Returns the vendor that implemented this package, null is returned if it is not known.

Returns:String: the vendor that implemented this package, null is returned if it is not known.

getImplementationVersion back to summary

getImplementationVersion	back to summary
public String getImplementationVersion() Return the version of this implementation. It consists of any string assigned by the vendor of this implementation and does not have any particular syntax specified or expected by the Java runtime. It may be compared for equality with other package version strings used for this implementation by this vendor for this package. Returns:String the version of the implementation, `null` is returned if it is not known.

public String getImplementationVersion()

Return the version of this implementation. It consists of any string assigned by the vendor of this implementation and does not have any particular syntax specified or expected by the Java runtime. It may be compared for equality with other package version strings used for this implementation by this vendor for this package.

Returns:String: the version of the implementation, null is returned if it is not known.

getName back to summary

getName	back to summary
public String getName() Return the name of this package. Returns:String The fully-qualified name of this package as defined in section 6.5.3 of The Java Language Specification, for example, `java.lang`

public String getName()

Return the name of this package.

Returns:String: The fully-qualified name of this package as defined in section 6.5.3 of The Java Language Specification, for example, java.lang

getPackage back to summary

getPackage	back to summary
public static Package getPackage(String name) Deprecated since 9. If multiple class loaders delegate to each other and define classes with the same package name, and one such loader relies on the lookup behavior of `getPackage` to return a `Package` from a parent loader, then the properties exposed by the `Package` may not be as expected in the rest of the program. For example, the `Package` will only expose annotations from the `package-info.class` file defined by the parent loader, even if annotations exist in a `package-info.class` file defined by a child loader. A more robust approach is to use the `ClassLoader#getDefinedPackage` method which returns a `Package` for the specified class loader. Finds a package by name in the caller's class loader and its ancestors. If the caller's class loader defines a `Package` of the given name, the `Package` is returned. Otherwise, the ancestors of the caller's class loader are searched recursively (parent by parent) for a `Package` of the given name. Calling this method is equivalent to calling `ClassLoader#getPackage` on a `ClassLoader` instance which is the caller's class loader. Parameters name:String A package name, such as "`java.lang`". Returns:Package The `Package` of the given name defined by the caller's class loader or its ancestors, or `null` if not found. Annotations @CallerSensitive @Deprecated since:9 @SuppressWarnings:deprecation Exceptions NullPointerException: if `name` is `null`. See Also `ClassLoader#getDefinedPackage`

public static Package getPackage(String name)

Deprecated

since 9.

If multiple class loaders delegate to each other and define classes with the same package name, and one such loader relies on the lookup behavior of getPackage to return a Package from a parent loader, then the properties exposed by the Package may not be as expected in the rest of the program. For example, the Package will only expose annotations from the package-info.class file defined by the parent loader, even if annotations exist in a package-info.class file defined by a child loader. A more robust approach is to use the ClassLoader#getDefinedPackage method which returns a Package for the specified class loader.

Finds a package by name in the caller's class loader and its ancestors.

If the caller's class loader defines a Package of the given name, the Package is returned. Otherwise, the ancestors of the caller's class loader are searched recursively (parent by parent) for a Package of the given name.

Calling this method is equivalent to calling ClassLoader#getPackage on a ClassLoader instance which is the caller's class loader.

Parameters

name:String: A package name, such as "java.lang".

Returns:Package

The Package of the given name defined by the caller's class loader or its ancestors, or null if not found.

Annotations

@CallerSensitive
@Deprecated
since:9
@SuppressWarnings:deprecation

Exceptions

NullPointerException:: if name is null.

See Also

ClassLoader#getDefinedPackage

getPackageInfo	back to summary
private Class<?> getPackageInfo()

getPackages back to summary

getPackages	back to summary
public static Package[] getPackages() Returns all of the `Package`s defined by the caller's class loader and its ancestors. The returned array may contain more than one `Package` object of the same package name, each defined by a different class loader in the class loader hierarchy. Calling this method is equivalent to calling `ClassLoader#getPackages` on a `ClassLoader` instance which is the caller's class loader. Returns:Package[] The array of `Package` objects defined by this class loader and its ancestors Annotations @CallerSensitive See Also `ClassLoader#getDefinedPackages`

public static Package[] getPackages()

Returns all of the Packages defined by the caller's class loader and its ancestors. The returned array may contain more than one Package object of the same package name, each defined by a different class loader in the class loader hierarchy.

Calling this method is equivalent to calling ClassLoader#getPackages on a ClassLoader instance which is the caller's class loader.

Returns:Package[]

The array of Package objects defined by this class loader and its ancestors

Annotations

@CallerSensitive

See Also

ClassLoader#getDefinedPackages

getSpecificationTitle back to summary

getSpecificationTitle	back to summary
public String getSpecificationTitle() Return the title of the specification that this package implements. Returns:String the specification title, `null` is returned if it is not known.

public String getSpecificationTitle()

Return the title of the specification that this package implements.

Returns:String: the specification title, null is returned if it is not known.

getSpecificationVendor back to summary

getSpecificationVendor	back to summary
public String getSpecificationVendor() Return the name of the organization, vendor, or company that owns and maintains the specification of the classes that implement this package. Returns:String the specification vendor, `null` is returned if it is not known.

public String getSpecificationVendor()

Return the name of the organization, vendor, or company that owns and maintains the specification of the classes that implement this package.

Returns:String: the specification vendor, null is returned if it is not known.

getSpecificationVersion back to summary

getSpecificationVersion	back to summary
public String getSpecificationVersion() Returns the version number of the specification that this package implements. This version string must be a sequence of non-negative decimal integers separated by "."'s and may have leading zeros. When version strings are compared the most significant numbers are compared. Specification version numbers use a syntax that consists of non-negative decimal integers separated by periods ".", for example "2.0" or "1.2.3.4.5.6.7". This allows an extensible number to be used to represent major, minor, micro, etc. versions. The version specification is described by the following formal grammar: SpecificationVersion: Digits RefinedVersion_opt RefinedVersion: `.` Digits `.` Digits RefinedVersion Digits: Digit Digits Digit: any character for which `Character#isDigit` returns `true`, e.g. 0, 1, 2, ... Returns:String the specification version, `null` is returned if it is not known.

public String getSpecificationVersion()

Returns the version number of the specification that this package implements. This version string must be a sequence of non-negative decimal integers separated by "."'s and may have leading zeros. When version strings are compared the most significant numbers are compared.

Specification version numbers use a syntax that consists of non-negative decimal integers separated by periods ".", for example "2.0" or "1.2.3.4.5.6.7". This allows an extensible number to be used to represent major, minor, micro, etc. versions. The version specification is described by the following formal grammar:

SpecificationVersion:
Digits RefinedVersion_opt
RefinedVersion:
. Digits
. Digits RefinedVersion
Digits:
Digit
Digits
Digit:
any character for which Character#isDigit returns true, e.g. 0, 1, 2, ...

Returns:String: the specification version, null is returned if it is not known.

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Return the hash code computed from the package name. Returns:int the hash code computed from the package name. Annotations @Override

hashCode

back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Return the hash code computed from the package name.

Returns:int

the hash code computed from the package name.

Annotations

@Override

isAnnotationPresent back to summary

isAnnotationPresent	back to summary
public boolean isAnnotationPresent(Class<? extends Annotation> annotationClass) Overrides default java.lang.reflect.AnnotatedElement.isAnnotationPresent. Doc from java.lang.reflect.AnnotatedElement.isAnnotationPresent. Returns true if an annotation for the specified type is present on this element, else false. This method is designed primarily for convenient access to marker annotations. The truth value returned by this method is equivalent to: `getAnnotation(annotationClass) != null` Parameters annotationClass:Class<? extends Annotation> the Class object corresponding to the annotation type Returns:boolean true if an annotation for the specified annotation type is present on this element, else false Annotations @Override Exceptions NullPointerException: if the given annotation class is null Since 1.5

public boolean isAnnotationPresent(Class<? extends Annotation> annotationClass)

Overrides default java.lang.reflect.AnnotatedElement.isAnnotationPresent.

Doc from java.lang.reflect.AnnotatedElement.isAnnotationPresent.

Returns true if an annotation for the specified type is present on this element, else false. This method is designed primarily for convenient access to marker annotations.

The truth value returned by this method is equivalent to: getAnnotation(annotationClass) != null

Parameters

annotationClass:Class<? extends Annotation>: the Class object corresponding to the annotation type

Returns:boolean

true if an annotation for the specified annotation type is present on this element, else false

Annotations

@Override

Exceptions

NullPointerException:: if the given annotation class is null

Since

1.5

isCompatibleWith	back to summary
public boolean isCompatibleWith(String desired) throws NumberFormatException Compare this package's specification version with a desired version. It returns true if this packages specification version number is greater than or equal to the desired version number. Version numbers are compared by sequentially comparing corresponding components of the desired and specification strings. Each component is converted as a decimal integer and the values compared. If the specification value is greater than the desired value true is returned. If the value is less false is returned. If the values are equal the period is skipped and the next pair of components is compared. Parameters desired:String the version string of the desired version. Returns:boolean true if this package's version number is greater than or equal to the desired version number Exceptions NumberFormatException: if the current version is not known or the desired or current version is not of the correct dotted form.

isCompatibleWith

back to summary

public boolean isCompatibleWith(String desired) throws NumberFormatException

Compare this package's specification version with a desired version. It returns true if this packages specification version number is greater than or equal to the desired version number.

Version numbers are compared by sequentially comparing corresponding components of the desired and specification strings. Each component is converted as a decimal integer and the values compared. If the specification value is greater than the desired value true is returned. If the value is less false is returned. If the values are equal the period is skipped and the next pair of components is compared.

Parameters

desired:String: the version string of the desired version.

Returns:boolean

true if this package's version number is greater than or equal to the desired version number

Exceptions

NumberFormatException:: if the current version is not known or the desired or current version is not of the correct dotted form.

isSealed back to summary

isSealed	back to summary
public boolean isSealed() Returns true if this package is sealed. API Note Package sealing has no relationship with sealed classes or interfaces. Package sealing is specific to JAR files defined for classes in an unnamed module. See the `Package` class specification for details how a `Package` is defined as sealed package. Returns:boolean true if the package is sealed, false otherwise

public boolean isSealed()

Returns true if this package is sealed.

API Note

Package sealing has no relationship with sealed classes or interfaces. Package sealing is specific to JAR files defined for classes in an unnamed module. See the Package class specification for details how a Package is defined as sealed package.

Returns:boolean: true if the package is sealed, false otherwise

isSealed back to summary

isSealed	back to summary
public boolean isSealed(URL url) Returns true if this package is sealed with respect to the specified code source `url`. API Note Package sealing has no relationship with sealed classes or interfaces. Package sealing is specific to JAR files defined for classes in an unnamed module. See the `Package` class specification for details how a `Package` is defined as sealed package. Parameters url:URL the code source URL Returns:boolean true if this package is sealed with respect to the given `url`

public boolean isSealed(URL url)

Returns true if this package is sealed with respect to the specified code source url.

API Note

Parameters

url:URL: the code source URL

Returns:boolean

true if this package is sealed with respect to the given url

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Returns the string representation of this Package. Its value is the string "package " and the package name. If the package title is defined it is appended. If the package version is defined it is appended. Returns:String the string representation of the package. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Returns the string representation of this Package. Its value is the string "package " and the package name. If the package title is defined it is appended. If the package version is defined it is appended.

Returns:String

the string representation of the package.

Annotations

@Override

Modifier and Type	Field and Description
private final String	implTitle
private final String	implVendor
private final String	implVersion
pack-priv static final Package.VersionInfo	NULL_VERSION_INFO
private final URL	sealBase
private final String	specTitle
private final String	specVendor
private final String	specVersion

public Class Package

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class Package.VersionInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail