A B C D E F G H I J K M N O P R S T V
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- api - org.glassfish.spec.Spec.JarType
-
A Specification with a separate API jar file.
- API_SUFFIX - Static variable in class org.glassfish.spec.Spec
-
ArtifactId suffix for Spec with
api
JarType. - apiJar - Variable in class org.glassfish.spec.maven.CommandLineMojo
-
Path to the API jar file.
- apiPackage - Variable in class org.glassfish.spec.maven.CommandLineMojo
-
API package.
- apiPackage - Variable in class org.glassfish.spec.Spec
-
The Spec API Package.
- artifact - Variable in class org.glassfish.spec.Spec
-
The Spec Artifact.
- Artifact - Class in org.glassfish.spec
-
Represent the API JAR file as a Maven artifact.
- Artifact() - Constructor for class org.glassfish.spec.Artifact
-
Create a new
Artifact
instance. - Artifact(String, String, String) - Constructor for class org.glassfish.spec.Artifact
-
Create a new
Artifact
instance. - artifactId - Variable in class org.glassfish.spec.Artifact
-
Artifact artifactId.
B
- buildBundleSymbolicName() - Method in class org.glassfish.spec.Spec
-
Build bundle symbolic name from API package and API_SUFFIX.
- BUNDLE_SPEC_VERSION - Static variable in class org.glassfish.spec.Metadata
-
Entry name for Bundle Spec Version.
- BUNDLE_SYMBOLIC_NAME - Static variable in class org.glassfish.spec.Metadata
-
Entry name for Bundle Symbolic Name.
- BUNDLE_VERSION - Static variable in class org.glassfish.spec.Metadata
-
Entry name for Bundle Version.
- bundleSpecVersion - Variable in class org.glassfish.spec.Metadata
-
Bundle Spec Version.
- bundleSymbolicName - Variable in class org.glassfish.spec.Metadata
-
Bundle Symbolic Name.
- bundleVersion - Variable in class org.glassfish.spec.Metadata
-
Bundle Version.
C
- checkClasses(JarFile, String...) - Method in class org.glassfish.spec.Spec
-
Verify that the classes inside the given jarFile match the right package.
- CheckDistributionMojo - Class in org.glassfish.spec.maven
-
Check a set of spec artifact in a staging directory.
- CheckDistributionMojo() - Constructor for class org.glassfish.spec.maven.CheckDistributionMojo
- CheckModuleMojo - Class in org.glassfish.spec.maven
-
Maven Goal to enforce spec rules and fail the build.
- CheckModuleMojo() - Constructor for class org.glassfish.spec.maven.CheckModuleMojo
- CommandLineMojo - Class in org.glassfish.spec.maven
-
Maven Goal to run spec verifications from the command line.
- CommandLineMojo() - Constructor for class org.glassfish.spec.maven.CommandLineMojo
- cons - Static variable in class org.glassfish.spec.maven.CommandLineMojo
-
The system console.
- COUNT - Static variable in enum org.glassfish.spec.SpecMode
-
Spec mode enumeration elements count.
D
- dir - Variable in class org.glassfish.spec.maven.CheckDistributionMojo
-
The directory containing the spec artifacts to process.
E
- equals(Object) - Method in class org.glassfish.spec.Artifact
- errors - Variable in class org.glassfish.spec.Metadata
-
List of collected errors.
- errors - Variable in class org.glassfish.spec.Spec
-
The errors during spec verification.
- excludes - Variable in class org.glassfish.spec.maven.CheckDistributionMojo
-
Exclude pattern.
- execute() - Method in class org.glassfish.spec.maven.CheckDistributionMojo
- execute() - Method in class org.glassfish.spec.maven.CheckModuleMojo
- execute() - Method in class org.glassfish.spec.maven.CommandLineMojo
- execute() - Method in class org.glassfish.spec.maven.SetPropertiesMojo
F
- fail(String) - Static method in class org.glassfish.spec.maven.CommandLineMojo
-
Print error and exit.
- fromJar(JarFile) - Static method in class org.glassfish.spec.Artifact
-
Create an
Artifact
instance from a given JAR file. - fromJar(JarFile) - Static method in class org.glassfish.spec.Metadata
-
Create a new
Metadata
instance from a JAR file.
G
- getAbsoluteVersion() - Method in class org.glassfish.spec.Artifact
-
Get the normalized release version for this artifact.
- getArtifact() - Method in class org.glassfish.spec.Spec
-
Get the Spec Artifact.
- getArtifactId() - Method in class org.glassfish.spec.Artifact
-
Get the artifactId for this artifact.
- getBundleSpecVersion() - Method in class org.glassfish.spec.Metadata
-
Get the bundle spec version entry.
- getBundleSymbolicName() - Method in class org.glassfish.spec.Metadata
-
Get the bundle symbolic name entry.
- getBundleVersion() - Method in class org.glassfish.spec.Metadata
-
Get the bundle version entry.
- getErrors() - Method in class org.glassfish.spec.Metadata
-
Get the metadata errors.
- getErrors() - Method in class org.glassfish.spec.Spec
-
Get the errors collected during verification.
- getGroupId() - Method in class org.glassfish.spec.Artifact
-
Get the groupId for this artifact.
- getJarExtensionName() - Method in class org.glassfish.spec.Metadata
-
Get the jar extension name entry.
- getjarImplementationVersion() - Method in class org.glassfish.spec.Metadata
-
Get the jar implementation version entry.
- getJarSpecificationVersion() - Method in class org.glassfish.spec.Metadata
-
Get the jar specification version entry.
- getMetadata() - Method in class org.glassfish.spec.Spec
-
Get the Spec Metadata.
- getPomPropertiesFile(JarFile) - Static method in class org.glassfish.spec.Artifact
-
Get the
ZipEntry
forpom.properties
in the given JAR file. - getProperties() - Method in class org.glassfish.spec.Metadata
-
Get the metadata properties.
- getSpec(File) - Method in class org.glassfish.spec.maven.CheckDistributionMojo
-
Find or create the specification configuration for the given artifact.
- getSpecMode(String) - Static method in enum org.glassfish.spec.SpecMode
-
Get spec plugin mode with corresponding name.
- getVersion() - Method in class org.glassfish.spec.Artifact
-
Get the version for this artifact.
- grePrefix() - Method in enum org.glassfish.spec.SpecMode
-
Returns group ID and package prefix for this mode.
- groupId - Variable in class org.glassfish.spec.Artifact
-
Artifact groupId.
H
- hashCode() - Method in class org.glassfish.spec.Artifact
- help - Variable in class org.glassfish.spec.maven.CommandLineMojo
-
Show the usage.
I
- ignoreErrors - Variable in class org.glassfish.spec.maven.CheckModuleMojo
-
Ignore failures.
- impl - org.glassfish.spec.Spec.JarType
-
A specification with a standalone API jar file.
- implBuild - Variable in class org.glassfish.spec.maven.CommandLineMojo
-
Implementation build.
- implBuild - Variable in class org.glassfish.spec.Spec
-
The Spec Implementation Builder Number.
- implJar - Variable in class org.glassfish.spec.maven.CommandLineMojo
-
Path to the Impl jar file.
- implNamespace - Variable in class org.glassfish.spec.maven.CommandLineMojo
-
Implementation namespace.
- implNamespace - Variable in class org.glassfish.spec.Spec
-
The Spec Implementation Namespace.
- implVersion - Variable in class org.glassfish.spec.maven.CommandLineMojo
-
Implementation version.
- implVersion - Variable in class org.glassfish.spec.Spec
-
The Spec Implementation Version.
- includes - Variable in class org.glassfish.spec.maven.CheckDistributionMojo
-
Include pattern.
- isFinal - Variable in class org.glassfish.spec.maven.CommandLineMojo
-
Is it a final specification?.
J
- JAKARTA - org.glassfish.spec.SpecMode
-
Jakarta EE4J spec mode for
jakarta
value ofspecMode
property. - JAKARTA_GROUP_ID - Static variable in class org.glassfish.spec.Spec
-
GroupId used for JakartaEE specs.
- jar - Variable in class org.glassfish.spec.Spec
-
The Spec JAR file.
- JAR_EXTENSION_NAME - Static variable in class org.glassfish.spec.Metadata
-
Entry name for Jar Extension Name.
- JAR_IMPLEMENTATION_VERSION - Static variable in class org.glassfish.spec.Metadata
-
Entry name for Jar Implementation Version.
- JAR_SPECIFICATION_VERSION - Static variable in class org.glassfish.spec.Metadata
-
Entry name for Jar Specification Version.
- jarExtensionName - Variable in class org.glassfish.spec.Metadata
-
Jar Extension Name.
- jarImplementationVersion - Variable in class org.glassfish.spec.Metadata
-
Jar Implementation Version.
- jarSpecificationVersion - Variable in class org.glassfish.spec.Metadata
-
Jar Specification Version.
- jarType - Variable in class org.glassfish.spec.maven.CommandLineMojo
-
Is it an API jar?.
- jarType - Variable in class org.glassfish.spec.Spec
-
The Spec Jar Type see
Spec.JarType
. - JarType() - Constructor for enum org.glassfish.spec.Spec.JarType
- JAVAEE - org.glassfish.spec.SpecMode
-
Java EE spec mode for
javaee
value ofspecMode
property (default). - JAVAX_GROUP_ID - Static variable in class org.glassfish.spec.Spec
-
GroupId used for JavaEE specs.
- JCP_VERSION_RULE - Static variable in class org.glassfish.spec.Spec
-
Constant for JCP Version Rule.
K
M
- metadata - Variable in class org.glassfish.spec.Spec
-
The Spec Artifact Metadata.
- Metadata - Class in org.glassfish.spec
-
Represents an API JAR
MANIFEST.MF
entries. - Metadata(String, String, String, String, String, String) - Constructor for class org.glassfish.spec.Metadata
-
Create a new
Metadata
instance. - Metadata(String, String, String, String, String, String, List<String>) - Constructor for class org.glassfish.spec.Metadata
-
Create a new
Metadata
instance. - module - Variable in class org.glassfish.spec.maven.CheckModuleMojo
-
Module to verify.
N
- name - Variable in enum org.glassfish.spec.SpecMode
-
Name of spec plugin mode.
- newImplVersion - Variable in class org.glassfish.spec.maven.CommandLineMojo
-
New implementation version.
- newImplVersion - Variable in class org.glassfish.spec.Spec
-
The Spec Implementation Version.
- newSpecVersion - Variable in class org.glassfish.spec.maven.CommandLineMojo
-
New spec version.
- newSpecVersion - Variable in class org.glassfish.spec.Spec
-
The new Spec Version (for non final API).
- nonFinal - Variable in class org.glassfish.spec.Spec
-
The Spec Final flag.
- NONFINAL_BUILD_SEPARATOR - Static variable in class org.glassfish.spec.Spec
-
Constant for Non Final API Build Separator.
- NONFINAL_BUILD_SEPARATOR_SPEC - Static variable in class org.glassfish.spec.Spec
-
Constant for Non Final API Build Spec Separator.
O
- org.glassfish.spec - package org.glassfish.spec
-
Utilities to enforce API metadata.
- org.glassfish.spec.maven - package org.glassfish.spec.maven
-
Maven plugin integration.
P
- prefix - Variable in enum org.glassfish.spec.SpecMode
-
Group ID and package prefix for this mode.
- printParam(String, String) - Static method in class org.glassfish.spec.maven.CommandLineMojo
-
Print a given parameter to the standard output.
- project - Variable in class org.glassfish.spec.maven.CheckModuleMojo
-
The maven project.
- project - Variable in class org.glassfish.spec.maven.SetPropertiesMojo
-
The maven project.
- prompt(String) - Static method in class org.glassfish.spec.maven.CommandLineMojo
-
Prompt with the string and return the user's input.
- properties - Variable in class org.glassfish.spec.maven.CommandLineMojo
-
Property file.
- properties - Variable in class org.glassfish.spec.Metadata
-
Properties.
R
- RC_QUALIFIER - Static variable in class org.glassfish.spec.Artifact
-
The Release Candidate qualifier.
- read(JarFile) - Method in class org.glassfish.spec.Spec
-
Populate the spec artifact and metadata from the given JAR file.
S
- setApiPackage(String) - Method in class org.glassfish.spec.Spec
-
Set the API package for this spec.
- setArtifact(Artifact) - Method in class org.glassfish.spec.Spec
-
Set the artifact for this spec.
- setArtifactId(String) - Method in class org.glassfish.spec.Artifact
-
Set the artifactId of this artifact.
- setGroupId(String) - Method in class org.glassfish.spec.Artifact
-
Set the groupId of this artifact.
- setImplBuild(String) - Method in class org.glassfish.spec.Spec
-
Set the implementation build for this spec.
- setImplNamespace(String) - Method in class org.glassfish.spec.Spec
-
Set the implementation namespace for this spec.
- setImplVersion(String) - Method in class org.glassfish.spec.Spec
-
Set the implementation version for this spec.
- setJarType(String) - Method in class org.glassfish.spec.Spec
-
Set the spec JAR type.
- setMetadata(Metadata) - Method in class org.glassfish.spec.Spec
-
Set metadata for this spec.
- setNewImplVersion(String) - Method in class org.glassfish.spec.Spec
-
Set the new spec implementation version for this spec.
- setNewSpecVersion(String) - Method in class org.glassfish.spec.Spec
-
Set the new spec version for this spec.
- setNonFinal(boolean) - Method in class org.glassfish.spec.Spec
-
Set the spec non final flag.
- SetPropertiesMojo - Class in org.glassfish.spec.maven
-
Generate spec properties.
- SetPropertiesMojo() - Constructor for class org.glassfish.spec.maven.SetPropertiesMojo
- setSpecBuild(String) - Method in class org.glassfish.spec.Spec
-
Set the spec build for this spec.
- setSpecImplVersion(String) - Method in class org.glassfish.spec.Spec
-
Set the spec implementation version for this spec.
- setSpecMode(String) - Method in class org.glassfish.spec.Spec
-
Set spec mode value for this spec.
- setSpecVersion(String) - Method in class org.glassfish.spec.Spec
-
Set the spec version for this spec.
- setVersion(String) - Method in class org.glassfish.spec.Artifact
-
Set the version of this artifact.
- SNAPSHOT_QUALIFIER - Static variable in class org.glassfish.spec.Artifact
-
The Maven SNAPSHOT qualifier.
- spec - Variable in class org.glassfish.spec.maven.CheckModuleMojo
-
Spec.
- spec - Variable in class org.glassfish.spec.maven.SetPropertiesMojo
-
The spec.
- Spec - Class in org.glassfish.spec
-
The API specification.
- Spec() - Constructor for class org.glassfish.spec.Spec
-
Create a new instance of
Spec
. - Spec.JarType - Enum in org.glassfish.spec
-
The different kind of Spec Jar files.
- specBuild - Variable in class org.glassfish.spec.maven.CommandLineMojo
-
Spec build.
- specBuild - Variable in class org.glassfish.spec.Spec
-
The Spec Build Number.
- specImplVersion - Variable in class org.glassfish.spec.maven.CommandLineMojo
-
Spec implementation version.
- specImplVersion - Variable in class org.glassfish.spec.Spec
-
The Spec Implementation Version.
- specMode - Variable in class org.glassfish.spec.maven.CheckModuleMojo
-
Mode.
- specMode - Variable in class org.glassfish.spec.maven.CommandLineMojo
-
Mode.
- specMode - Variable in class org.glassfish.spec.maven.SetPropertiesMojo
-
Mode.
- specMode - Variable in class org.glassfish.spec.Spec
-
The Spec mode (
"javaee"
or"jakarta"
). - SpecMode - Enum in org.glassfish.spec
-
API specification modes.
- SpecMode(String, String) - Constructor for enum org.glassfish.spec.SpecMode
-
Creates an instance of spec plugin mode.
- specs - Variable in class org.glassfish.spec.maven.CheckDistributionMojo
-
The specification configurations.
- specVersion - Variable in class org.glassfish.spec.maven.CommandLineMojo
-
Spec version.
- specVersion - Variable in class org.glassfish.spec.Spec
-
The Spec Version.
- STR_TO_SPECMODE_MAP - Static variable in enum org.glassfish.spec.SpecMode
-
Spec mode name to SpecMode instance conversion map.
- stripSnapshotOrRcQualifier(String) - Static method in class org.glassfish.spec.Artifact
-
Strip the SNAPSHOT or RC qualifier from a given version.
T
- toString() - Method in class org.glassfish.spec.Artifact
- toString() - Method in class org.glassfish.spec.Spec
-
Create a readable inline description of the spec.
V
- valueOf(String) - Static method in enum org.glassfish.spec.Spec.JarType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.glassfish.spec.SpecMode
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum org.glassfish.spec.Spec.JarType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.glassfish.spec.SpecMode
-
Returns an array containing the constants of this enum type, in the order they are declared.
- verify() - Method in class org.glassfish.spec.Spec
-
Perform the Spec verification.
- verifyApiPackagePrefix() - Method in class org.glassfish.spec.Spec
-
Verify that apiPackage starts with proper prefix.
- version - Variable in class org.glassfish.spec.Artifact
-
Artifact version.
All Classes All Packages