org.apache.tools.ant.taskdefs.optional.extension
Class Specification
java.lang.Object
org.apache.tools.ant.taskdefs.optional.extension.Specification
public final class Specification
extends java.lang.Object
Utility class that represents either an available "Optional Package"
(formerly known as "Standard Extension") as described in the manifest
of a JAR file, or the requirement for such an optional package.
For more information about optional packages, see the document
Optional Package Versioning in the documentation bundle for your
Java2 Standard Edition package, in file
guide/extensions/versioning.html
.
Specification(String specificationTitle, String specificationVersion, String specificationVendor, String implementationTitle, String implementationVersion, String implementationVendor) - The constructor to create Package Specification object.
|
Specification(String specificationTitle, String specificationVersion, String specificationVendor, String implementationTitle, String implementationVersion, String implementationVendor, String[] sections) - The constructor to create Package Specification object.
|
COMPATIBLE
public static final Compatibility COMPATIBLE
Enum indicating that extension is compatible with other Package
Specification.
IMPLEMENTATION_TITLE
public static final Attributes.Name IMPLEMENTATION_TITLE
Manifest Attribute Name object for IMPLEMENTATION_TITLE.
IMPLEMENTATION_VENDOR
public static final Attributes.Name IMPLEMENTATION_VENDOR
Manifest Attribute Name object for IMPLEMENTATION_VENDOR.
IMPLEMENTATION_VERSION
public static final Attributes.Name IMPLEMENTATION_VERSION
Manifest Attribute Name object for IMPLEMENTATION_VERSION.
INCOMPATIBLE
public static final Compatibility INCOMPATIBLE
This enum indicates that an extension is incompatible with
other Package Specification in ways other than other enums
indicate. For example, the other Package Specification
may have a different ID.
REQUIRE_IMPLEMENTATION_CHANGE
public static final Compatibility REQUIRE_IMPLEMENTATION_CHANGE
Enum indicating that extension requires an upgrade
of implementation to be compatible with other Package Specification.
REQUIRE_SPECIFICATION_UPGRADE
public static final Compatibility REQUIRE_SPECIFICATION_UPGRADE
Enum indicating that extension requires an upgrade
of specification to be compatible with other Package Specification.
REQUIRE_VENDOR_SWITCH
public static final Compatibility REQUIRE_VENDOR_SWITCH
Enum indicating that extension requires a vendor
switch to be compatible with other Package Specification.
SPECIFICATION_TITLE
public static final Attributes.Name SPECIFICATION_TITLE
Manifest Attribute Name object for SPECIFICATION_TITLE.
SPECIFICATION_VENDOR
public static final Attributes.Name SPECIFICATION_VENDOR
Manifest Attribute Name object for SPECIFICATION_VENDOR.
SPECIFICATION_VERSION
public static final Attributes.Name SPECIFICATION_VERSION
Manifest Attribute Name object for SPECIFICATION_VERSION.
Specification
public Specification(String specificationTitle,
String specificationVersion,
String specificationVendor,
String implementationTitle,
String implementationVersion,
String implementationVendor)
The constructor to create Package Specification object.
Note that every component is allowed to be specified
but only the specificationTitle is mandatory.
specificationTitle
- the name of specification.specificationVersion
- the specification Version.specificationVendor
- the specification Vendor.implementationTitle
- the title of implementation.implementationVersion
- the implementation Version.implementationVendor
- the implementation Vendor.
Specification
public Specification(String specificationTitle,
String specificationVersion,
String specificationVendor,
String implementationTitle,
String implementationVersion,
String implementationVendor,
String[] sections)
The constructor to create Package Specification object.
Note that every component is allowed to be specified
but only the specificationTitle is mandatory.
specificationTitle
- the name of specification.specificationVersion
- the specification Version.specificationVendor
- the specification Vendor.implementationTitle
- the title of implementation.implementationVersion
- the implementation Version.implementationVendor
- the implementation Vendor.sections
- the sections/packages that Specification applies to.
getCompatibilityWith
public Compatibility getCompatibilityWith(Specification other)
Return a Compatibility enum indicating the relationship of this
Package Specification
with the specified
Extension
.
other
- the other specification
- the enum indicating the compatibility (or lack thereof)
of specifed Package Specification
getImplementationTitle
public String getImplementationTitle()
Get the title of the specification.
- the title of the specification.
getImplementationVendor
public String getImplementationVendor()
Get the vendor of the extensions implementation.
- the vendor of the extensions implementation.
getImplementationVersion
public String getImplementationVersion()
Get the version of the implementation.
- the version of the implementation.
getSections
public String[] getSections()
Return an array containing sections to which specification applies
or null if relevent to no sections.
- an array containing sections to which specification applies
or null if relevent to no sections.
getSpecificationTitle
public String getSpecificationTitle()
Get the title of the specification.
- the title of speciication
getSpecificationVendor
public String getSpecificationVendor()
Get the vendor of the specification.
- the vendor of the specification.
getSpecificationVersion
public DeweyDecimal getSpecificationVersion()
Get the version of the specification.
- the version of the specification.
getSpecifications
public static Specification[] getSpecifications(Manifest manifest)
throws ParseException
Return an array of Package Specification
objects.
If there are no such optional packages, a zero-length array is returned.
manifest
- Manifest to be parsed
- the Package Specifications extensions in specified manifest
isCompatibleWith
public boolean isCompatibleWith(Specification other)
Return true
if the specified package
is satisfied by this Specification
. Otherwise, return
false
.
other
- the specification
- true if the specification is compatible with this specification
toString
public String toString()
Return a String representation of this object.
- string representation of object.
Copyright © 2000-2006 Apache Software Foundation. All Rights Reserved.