org.springframework.roo.project.packaging

Class JarPackaging

java.lang.Object

org.springframework.roo.project.packaging.AbstractPackagingProvider

org.springframework.roo.project.packaging.JarPackaging

All Implemented Interfaces:

CorePackagingProvider, PackagingProvider

@Service
public class JarPackaging
extends AbstractPackagingProvider

The PackagingProvider that creates a JAR file.

Since:

1.2.0

Author:

Andrew Swan, Paula Navarro

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Fields inherited from class org.springframework.roo.project.packaging.AbstractPackagingProvider

fileManager, LOGGER, pathResolver, ROO_PACKAGING_PROVIDER_PROPERTY

Constructor Summary

Constructors

Constructor and Description
JarPackaging() Constructor invoked by the OSGi container

Method Summary

Modifier and Type	Method and Description
protected String	createPom(org.springframework.roo.model.JavaPackage topLevelPackage, String nullableProjectName, String javaVersion, GAV parentPom, String moduleName, ProjectOperations projectOperations) Creates the Maven POM using the subclass' POM template as follows: sets the parent POM to the given parent (if any) sets the groupId to the result of AbstractPackagingProvider.getGroupId(org.springframework.roo.model.JavaPackage), omitting this element if it's the same as the parent's groupId (as per Maven best practice) sets the artifactId to the result of AbstractPackagingProvider.getArtifactId(java.lang.String, java.lang.String, org.springframework.roo.model.JavaPackage) sets the packaging to the result of #getName() sets the project name to the result of AbstractPackagingProvider.getProjectName(java.lang.String, java.lang.String, org.springframework.roo.model.JavaPackage) replaces all occurrences of AbstractPackagingProvider.JAVA_PRODUCT_VERSION_PLACEHOLDER with the given Java version This method makes as few assumptions about the POM template as possible, to make life easier for anyone writing a PackagingProvider.
Collection<Path>	getPaths() Returns the Paths to be created for this module, in addition to Path.ROOT.
boolean	isDefault() Indicates whether this type of packaging should be used for new projects and modules by default, i.e. when the user doesn't specify the packaging.
protected void	setPackagingProviderId(Document pom) Stores the ID of this PackagingProvider as a POM property called "roo.packaging.provider".

Methods inherited from class org.springframework.roo.project.packaging.AbstractPackagingProvider

activate, createArtifacts, createOtherArtifacts, getArtifactId, getFileManager, getFullyQualifiedModuleName, getGroupId, getId, getPathResolver, getProjectName, setGroupIdAndParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.roo.project.packaging.PackagingProvider

createArtifacts, getId

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

JarPackaging

public JarPackaging()

Constructor invoked by the OSGi container

Method Detail

createPom

protected String createPom(org.springframework.roo.model.JavaPackage topLevelPackage,
                           String nullableProjectName,
                           String javaVersion,
                           GAV parentPom,
                           String moduleName,
                           ProjectOperations projectOperations)

Description copied from class: AbstractPackagingProvider

Creates the Maven POM using the subclass' POM template as follows:

• sets the parent POM to the given parent (if any)
• sets the groupId to the result of AbstractPackagingProvider.getGroupId(org.springframework.roo.model.JavaPackage), omitting this element if it's the same as the parent's groupId (as per Maven best practice)
• sets the artifactId to the result of AbstractPackagingProvider.getArtifactId(java.lang.String, java.lang.String, org.springframework.roo.model.JavaPackage)
• sets the packaging to the result of #getName()
• sets the project name to the result of AbstractPackagingProvider.getProjectName(java.lang.String, java.lang.String, org.springframework.roo.model.JavaPackage)
• replaces all occurrences of AbstractPackagingProvider.JAVA_PRODUCT_VERSION_PLACEHOLDER with the given Java version

This method makes as few assumptions about the POM template as possible, to make life easier for anyone writing a PackagingProvider.

Overrides:

createPom in class AbstractPackagingProvider

Parameters:

topLevelPackage - the new project or module's top-level Java package (required)

nullableProjectName - the project name provided by the user (can be blank)

javaVersion - the Java version to substitute into the POM (required)

parentPom - the Maven coordinates of the parent POM (can be null)

moduleName - the unqualified name of the Maven module to which the new POM belongs

projectOperations - cannot be injected otherwise it's a circular dependency

Returns:

the path of the newly created POM

getPaths

public Collection<Path> getPaths()

Description copied from interface: PackagingProvider

Returns the Paths to be created for this module, in addition to Path.ROOT.

Returns:

isDefault

public boolean isDefault()

Description copied from interface: PackagingProvider

Indicates whether this type of packaging should be used for new projects and modules by default, i.e. when the user doesn't specify the packaging.

If the user defines their own PackagingProviders, they should ensure that at most one of them returns true from this method.

Specified by:

isDefault in interface PackagingProvider

Returns:

see above

setPackagingProviderId

protected final void setPackagingProviderId(Document pom)

Description copied from class: AbstractPackagingProvider

Stores the ID of this PackagingProvider as a POM property called "roo.packaging.provider". Subclasses can override this method, but be aware that Roo needs some way of working out from a given pom.xml file which PackagingProvider should be used.

Overrides:

setPackagingProviderId in class AbstractPackagingProvider

Parameters:

pom - the DOM document for the POM being created