| java.lang.Object
 java.lang.Package
| Package | | public class Package (Code) | | Package objects contain version information
about the implementation and specification of a Java package.
This versioning information is retrieved and made available
by the
ClassLoader ClassLoader instance that
loaded the class(es). Typically, it is stored in the manifest that is
distributed with the classes.
The set of classes that make up the package may implement a
particular specification and if so the specification title, version number,
and vendor strings identify that specification.
An application can ask if the package is
compatible with a particular version, see the
Package.isCompatibleWithisCompatibleWith method for details.
Specification version numbers use a syntax that consists of positive
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 RefinedVersionopt
- RefinedVersion:
. Digits
. Digits RefinedVersion
- Digits:
- Digit
- Digits
- Digit:
- any character for which
Character.isDigit returns
true,
e.g. 0, 1, 2, ...
The implementation title, version, and vendor strings identify an
implementation and are made available conveniently to enable accurate
reporting of the packages involved when a problem occurs. The contents
all three implementation strings are vendor specific. The
implementation version strings have no specified syntax and should
only be compared for equality with desired version identifers.
Within each ClassLoader instance all classes from the same
java package have the same Package object. The static methods allow a package
to be found by name or the set of all packages known to the current class
loader to be found.
See Also: ClassLoader.definePackage |
| Method Summary | |
| public String | getImplementationTitle()
Return the title of this package. | | public String | getImplementationVendor()
Returns the name of the organization,
vendor or company that provided this implementation. | | public String | getImplementationVersion()
Return the version of this implementation. | | public String | getName()
Return the name of this package.
The name of this package using the Java language dot notationfor the package. | | public static Package | getPackage(String name)
Find a package by name in the callers ClassLoader instance.
The callers ClassLoader instance is used to find the package
instance corresponding to the named class. | | static Package | getPackage(Class c)
Get the package for the specified class.
The class's class loader is used to find the package instance
corresponding to the specified class. | | public static Package[] | getPackages()
Get all the packages currently known for the caller's ClassLoader
instance. | | public String | getSpecificationTitle()
Return the title of the specification that this package implements. | | 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. | | public String | getSpecificationVersion()
Returns the version number of the specification
that this package implements. | | static Package | getSystemPackage(String name)
| | static Package[] | getSystemPackages()
| | public int | hashCode()
Return the hash code computed from the package name. | | public boolean | isCompatibleWith(String desired)
Compare this package's specification version with a
desired version. | | public boolean | isSealed()
Returns true if this package is sealed. | | public boolean | isSealed(URL url)
Returns true if this package is sealed with respect to the specified
code source url. | | public String | toString()
Returns the string representation of this Package. |
| Package | | Package(String name, String spectitle, String specversion, String specvendor, String impltitle, String implversion, String implvendor, URL sealbase)(Code) | | Construct a package instance with the specified version
information.
Parameters:
pkgName - the name of the package
Parameters:
spectitle - the title of the specification
Parameters:
specversion - the version of the specification
Parameters:
specvendor - the organization that maintains the specification
Parameters:
impltitle - the title of the implementation
Parameters:
implversion - the version of the implementation
Parameters:
implvendor - the organization that maintains the implementation a new package for containing the specified information. |
| getImplementationTitle | | public String getImplementationTitle()(Code) | | Return the title of this package.
the title of the implementation, null is returned if it is not known. |
| getImplementationVendor | | public String getImplementationVendor()(Code) | | Returns the name of the organization,
vendor or company that provided this implementation.
the vendor that implemented this package.. |
| getImplementationVersion | | public String getImplementationVersion()(Code) | | 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.
the version of the implementation, null is returned if it is not known. |
| getName | | public String getName()(Code) | | Return the name of this package.
The name of this package using the Java language dot notationfor the package. i.e java.lang |
| getPackage | | public static Package getPackage(String name)(Code) | | Find a package by name in the callers ClassLoader instance.
The callers ClassLoader instance is used to find the package
instance corresponding to the named class. If the callers
ClassLoader instance is null then the set of packages loaded
by the system ClassLoader instance is searched to find the
named package.
Packages have attributes for versions and specifications only if the class
loader created the package instance with the appropriate attributes. Typically,
those attributes are defined in the manifests that accompany the classes.
Parameters:
name - a package name, for example, java.lang. the package of the requested name. It may be null if no packageinformation is available from the archive or codebase. |
| getPackage | | static Package getPackage(Class c)(Code) | | Get the package for the specified class.
The class's class loader is used to find the package instance
corresponding to the specified class. If the class loader
is the bootstrap class loader, which may be represented by
null in some implementations, then the set of packages
loaded by the bootstrap class loader is searched to find the package.
Packages have attributes for versions and specifications only
if the class loader created the package
instance with the appropriate attributes. Typically those
attributes are defined in the manifests that accompany
the classes.
class the class to get the package of. the package of the class. It may be null if no packageinformation is available from the archive or codebase. |
| getPackages | | public static Package[] getPackages()(Code) | | Get all the packages currently known for the caller's ClassLoader
instance. Those packages correspond to classes loaded via or accessible by
name to that ClassLoader instance. If the caller's
ClassLoader instance is the bootstrap ClassLoader
instance, which may be represented by null in some implementations,
only packages corresponding to classes loaded by the bootstrap
ClassLoader instance will be returned.
a new array of packages known to the callers ClassLoaderinstance. An zero length array is returned if none are known. |
| getSpecificationTitle | | public String getSpecificationTitle()(Code) | | Return the title of the specification that this package implements.
the specification title, null is returned if it is not known. |
| getSpecificationVendor | | public String getSpecificationVendor()(Code) | | Return the name of the organization, vendor,
or company that owns and maintains the specification
of the classes that implement this package.
the specification vendor, null is returned if it is not known. |
| getSpecificationVersion | | public String getSpecificationVersion()(Code) | | Returns the version number of the specification
that this package implements.
This version string must be a sequence of positive decimal
integers separated by "."'s and may have leading zeros.
When version strings are compared the most significant
numbers are compared.
the specification version, null is returned if it is not known. |
| hashCode | | public int hashCode()(Code) | | Return the hash code computed from the package name.
the hash code computed from the package name. |
| isCompatibleWith | | public boolean isCompatibleWith(String desired) throws NumberFormatException(Code) | | 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 - the version string of the desired version. true if this package's version number is greaterthan or equal to the desired version number
exception:
NumberFormatException - if the desired or current versionis not of the correct dotted form. |
| isSealed | | public boolean isSealed()(Code) | | Returns true if this package is sealed.
true if the package is sealed, false otherwise |
| isSealed | | public boolean isSealed(URL url)(Code) | | Returns true if this package is sealed with respect to the specified
code source url.
Parameters:
url - the code source url true if this package is sealed with respect to url |
| toString | | public String toString()(Code) | | 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.
the string representation of the package. |
|
|