org.springframework.roo.project.packaging

Interface PackagingProvider

All Known Subinterfaces:

CorePackagingProvider

All Known Implementing Classes:

AbstractPackagingProvider, BundlePackaging, EarPackaging, EsaPackaging, JarPackaging, PomPackaging, WarPackaging

public interface PackagingProvider

Creates the initial set of artifacts for a given Maven packaging type.

Since:

1.2.0

Author:

Andrew Swan

Method Summary

Modifier and Type	Method and Description
String	createArtifacts(org.springframework.roo.model.JavaPackage topLevelPackage, String projectName, String javaVersion, GAV parentPom, String moduleName, ProjectOperations projectOperations) Creates the initial set of artifacts (files and directories) for a module with this type of packaging; this includes setting the POM's /project/packaging element to the desired value.
String	getId() Returns the unique identifier of this PackagingProvider, for use in the Roo user interface.
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.

Method Detail

createArtifacts

String createArtifacts(org.springframework.roo.model.JavaPackage topLevelPackage,
                       String projectName,
                       String javaVersion,
                       GAV parentPom,
                       String moduleName,
                       ProjectOperations projectOperations)

Creates the initial set of artifacts (files and directories) for a module with this type of packaging; this includes setting the POM's /project/packaging element to the desired value.

Parameters:

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

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

javaVersion - the Java version for this project or module (required)

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

moduleName - the name of the module being created (blank for the root or only module)

projectOperations - in case it's required (never null)

Returns:

the path of the newly created POM

getId

String getId()

Returns the unique identifier of this PackagingProvider, for use in the Roo user interface.

The intent of this method is to allow third-party addons to provide alternative behaviour for a given Maven packaging type. For example, the core Roo WAR packaging type will have an ID of "war". If the user wants to customise how WAR modules are generated, they can implement their own PackagingProvider with an ID of (say) "custom-war". Then when the user adds a new module to their project, the shell will offer them the choice of "WAR" and "CUSTOM-WAR" for the packaging type.

Returns:

a non-blank ID, unique when case is ignored

getPaths

Collection<Path> getPaths()

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

Returns:

isDefault

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.

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

Returns:

see above