org.springframework.roo.project.packaging

Class PomPackaging

java.lang.Object

org.springframework.roo.project.packaging.AbstractPackagingProvider

org.springframework.roo.project.packaging.PomPackaging

All Implemented Interfaces:

CorePackagingProvider, PackagingProvider

@Service
public class PomPackaging
extends AbstractPackagingProvider

The Maven "pom" PackagingProvider

Since:

1.2.0

Author:

Andrew Swan

Field Summary

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

fileManager, LOGGER, pathResolver, ROO_PACKAGING_PROVIDER_PROPERTY

Constructor Summary

Constructors

Constructor and Description
PomPackaging() Constructor

Method Summary

Modifier and Type	Method and Description
protected void	createOtherArtifacts(org.springframework.roo.model.JavaPackage topLevelPackage, String module, ProjectOperations projectOperations) Subclasses can override this method to create any other required files or directories (apart from the POM, which has previously been generated by AbstractPackagingProvider.createPom(org.springframework.roo.model.JavaPackage, java.lang.String, java.lang.String, org.springframework.roo.project.GAV, java.lang.String, org.springframework.roo.project.ProjectOperations)).
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, createPom, 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

Constructor Detail

PomPackaging

public PomPackaging()

Constructor

Method Detail

createOtherArtifacts

protected void createOtherArtifacts(org.springframework.roo.model.JavaPackage topLevelPackage,
                                    String module,
                                    ProjectOperations projectOperations)

Description copied from class: AbstractPackagingProvider

Subclasses can override this method to create any other required files or directories (apart from the POM, which has previously been generated by AbstractPackagingProvider.createPom(org.springframework.roo.model.JavaPackage, java.lang.String, java.lang.String, org.springframework.roo.project.GAV, java.lang.String, org.springframework.roo.project.ProjectOperations)).

This implementation sets up the Log4j configuration file for the root module.

Overrides:

createOtherArtifacts in class AbstractPackagingProvider

module - the unqualified name of the module being created (empty means the root or only module)

projectOperations - can't be injected as it would create a circular dependency

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