AbstractCorePackagingProvider.java

package org.springframework.roo.project.packaging;

import org.w3c.dom.Document;

/**
 * A {@link PackagingProvider} provided by Spring Roo, i.e. not by a third-party
 * addon.
 * 
 * @author Andrew Swan
 * @author Paula Navarro
 * @since 1.2.0
 */
abstract class AbstractCorePackagingProvider extends AbstractPackagingProvider implements
    CorePackagingProvider {

  /**
   * Constructor
   * 
   * @param name the name of this type of packaging as used in the POM
   *            (required)
   * @param pomTemplate the path of this packaging type's POM template,
   *            relative to its own package, as per
   *            {@link Class#getResourceAsStream(String)}; this template
   *            should contain a "parent" element with its own groupId,
   *            artifactId, and version elements; this parent element will be
   *            removed if not required
   */
  protected AbstractCorePackagingProvider(final String name, final String pomTemplate) {
    /*
     * Core instances use the Maven packaging name as the ID so that the
     * user sees intuitively-named packaging options on the command line. If
     * they implement their own packaging types, they can name them with any
     * other name that makes sense to them.
     */
    super(name, name, pomTemplate);
  }

  /**
   * Constructor
   * 
   * @param name the name of this type of packaging as used in the POM
   *            (required)
   * @param pomTemplate the path of this packaging type's POM template,
   *            relative to its own package, as per
   *            {@link Class#getResourceAsStream(String)}; this template
   *            should contain a "parent" element with its own groupId,
   *            artifactId, and version elements; this parent element will be
   *            removed if not required
   * @param pomModuleTemplate the path of this packaging type's POM module template,
   *            relative to its own package, as per
   *            {@link Class#getResourceAsStream(String)}; this template
   *            should contain a "parent" element with its own groupId,
   *            artifactId, and version elements; can be <code>null</code>
   */
  protected AbstractCorePackagingProvider(final String name, final String pomTemplate,
      final String pomModuleTemplate) {
    /*
     * Core instances use the Maven packaging name as the ID so that the
     * user sees intuitively-named packaging options on the command line. If
     * they implement their own packaging types, they can name them with any
     * other name that makes sense to them.
     */
    super(name, name, pomTemplate, pomModuleTemplate);
  }

  public boolean isDefault() {
    return false;
  }

  @Override
  protected final void setPackagingProviderId(final Document pom) {
    // Not needed, as the core providers use the Maven packaging name as
    // their IDs.
  }
}