org.apache.maven.plugin.ant
Class AntBuildWriterUtil

java.lang.Object
  extended by org.apache.maven.plugin.ant.AntBuildWriterUtil

public class AntBuildWriterUtil
extends java.lang.Object

Utility class for the AntBuildWriter class.

Version:
$Id: AntBuildWriterUtil.java 833678 2009-11-07 14:02:13Z bentmann $
Author:
Vincent Siveton

Constructor Summary
AntBuildWriterUtil()
           
 
Method Summary
static void addWrapAttribute(org.codehaus.plexus.util.xml.XMLWriter writer, java.lang.String tag, java.lang.String name, java.lang.String value, int indent)
          Convenience method to wrap long element tags for a given attribute.
static java.lang.String getMavenCompilerPluginBasicOption(org.apache.maven.project.MavenProject project, java.lang.String optionName, java.lang.String defaultValue)
          Return the optionName value defined in a project for the "maven-compiler-plugin" plugin.
static java.util.Map getMavenCompilerPluginOption(org.apache.maven.project.MavenProject project, java.lang.String optionName, java.lang.String defaultValue)
          Return the map of optionName value defined in a project for the "maven-compiler-plugin" plugin.
static java.util.Map[] getMavenCompilerPluginOptions(org.apache.maven.project.MavenProject project, java.lang.String optionName, java.lang.String defaultValue)
          Return an array of map of optionName value defined in a project for the "maven-compiler-plugin" plugin.
static java.lang.String getMavenEarPluginBasicOption(org.apache.maven.project.MavenProject project, java.lang.String optionName, java.lang.String defaultValue)
          Return the optionName value defined in a project for the "maven-ear-plugin" plugin.
static java.lang.String getMavenJarPluginBasicOption(org.apache.maven.project.MavenProject project, java.lang.String optionName, java.lang.String defaultValue)
          Return the optionName value defined in a project for the "maven-jar-plugin" plugin.
static java.lang.String getMavenJavadocPluginBasicOption(org.apache.maven.project.MavenProject project, java.lang.String optionName, java.lang.String defaultValue)
          Return the optionName value defined in a project for the "maven-javadoc-plugin" plugin.
static java.util.Map getMavenJavadocPluginOption(org.apache.maven.project.MavenProject project, java.lang.String optionName, java.lang.String defaultValue)
          Return a map of optionName value defined in a project for the "maven-javadoc-plugin" plugin.
static java.util.Map[] getMavenJavadocPluginOptions(org.apache.maven.project.MavenProject project, java.lang.String optionName, java.lang.String defaultValue)
          Return an array of map of optionName value defined in a project for the "maven-javadoc-plugin" plugin.
static java.lang.String getMavenSurefirePluginBasicOption(org.apache.maven.project.MavenProject project, java.lang.String optionName, java.lang.String defaultValue)
          Return the optionName value defined in a project for the "maven-surefire-plugin" plugin.
static java.util.Map getMavenSurefirePluginOption(org.apache.maven.project.MavenProject project, java.lang.String optionName, java.lang.String defaultValue)
          Return the map of optionName value defined in a project for the "maven-surefire-plugin" plugin.
static java.util.Map[] getMavenSurefirePluginOptions(org.apache.maven.project.MavenProject project, java.lang.String optionName, java.lang.String defaultValue)
          Return an array of map of optionName value defined in a project for the "maven-surefire-plugin" plugin.
static java.lang.String getMavenWarPluginBasicOption(org.apache.maven.project.MavenProject project, java.lang.String optionName, java.lang.String defaultValue)
          Return the optionName value defined in a project for the "maven-war-plugin" plugin.
static boolean isBundlePackaging(org.apache.maven.project.MavenProject mavenProject)
           
static boolean isEarPackaging(org.apache.maven.project.MavenProject mavenProject)
           
static boolean isEjbPackaging(org.apache.maven.project.MavenProject mavenProject)
           
static boolean isJarPackaging(org.apache.maven.project.MavenProject mavenProject)
           
static boolean isMavenPluginPackaging(org.apache.maven.project.MavenProject mavenProject)
           
static boolean isPomPackaging(org.apache.maven.project.MavenProject mavenProject)
           
static boolean isWarPackaging(org.apache.maven.project.MavenProject mavenProject)
           
static java.util.List removeEmptyCompileSourceRoots(java.util.List compileSourceRoots)
           
static void writeAntTask(org.codehaus.plexus.util.xml.XMLWriter writer, org.apache.maven.project.MavenProject project, java.lang.String moduleSubPath, java.lang.String tasks)
          Convenience method to write XML ant task
static void writeAntVersionHeader(org.codehaus.plexus.util.xml.XMLWriter writer)
          Write comment for the Ant supported version
static void writeEarTask(org.codehaus.plexus.util.xml.XMLWriter writer, org.apache.maven.project.MavenProject project, ArtifactResolverWrapper artifactResolverWrapper)
          Convenience method to write XML Ant ear task
static void writeHeader(org.codehaus.plexus.util.xml.XMLWriter writer)
          Write comments in the Ant build file header
static void writeIncludesExcludes(org.codehaus.plexus.util.xml.XMLWriter writer, java.util.List includes, java.util.List excludes)
          Convenience method to write <include/> and <exclude/>
static void writeJarTask(org.codehaus.plexus.util.xml.XMLWriter writer, org.apache.maven.project.MavenProject project)
          Convenience method to write XML Ant jar task
static void writeJavadocTask(org.codehaus.plexus.util.xml.XMLWriter writer, org.apache.maven.project.MavenProject project, ArtifactResolverWrapper wrapper)
          Convenience method to write XML Ant javadoc task
static void writeWarTask(org.codehaus.plexus.util.xml.XMLWriter writer, org.apache.maven.project.MavenProject project, ArtifactResolverWrapper artifactResolverWrapper)
          Convenience method to write XML Ant war task
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AntBuildWriterUtil

public AntBuildWriterUtil()
Method Detail

removeEmptyCompileSourceRoots

public static java.util.List removeEmptyCompileSourceRoots(java.util.List compileSourceRoots)
Parameters:
compileSourceRoots -
Returns:
not null list

writeIncludesExcludes

public static void writeIncludesExcludes(org.codehaus.plexus.util.xml.XMLWriter writer,
                                         java.util.List includes,
                                         java.util.List excludes)
Convenience method to write <include/> and <exclude/>

Parameters:
writer - not null
includes -
excludes -

writeHeader

public static void writeHeader(org.codehaus.plexus.util.xml.XMLWriter writer)
Write comments in the Ant build file header

Parameters:
writer -

writeAntVersionHeader

public static void writeAntVersionHeader(org.codehaus.plexus.util.xml.XMLWriter writer)
Write comment for the Ant supported version

Parameters:
writer -

writeAntTask

public static void writeAntTask(org.codehaus.plexus.util.xml.XMLWriter writer,
                                org.apache.maven.project.MavenProject project,
                                java.lang.String moduleSubPath,
                                java.lang.String tasks)
Convenience method to write XML ant task

Parameters:
writer - not null
project - not null
moduleSubPath - not null
tasks - not null

writeJavadocTask

public static void writeJavadocTask(org.codehaus.plexus.util.xml.XMLWriter writer,
                                    org.apache.maven.project.MavenProject project,
                                    ArtifactResolverWrapper wrapper)
                             throws java.io.IOException
Convenience method to write XML Ant javadoc task

Parameters:
writer - not null
project - not null
wrapper - not null
Throws:
java.io.IOException - if any

writeJarTask

public static void writeJarTask(org.codehaus.plexus.util.xml.XMLWriter writer,
                                org.apache.maven.project.MavenProject project)
                         throws java.io.IOException
Convenience method to write XML Ant jar task

Parameters:
writer - not null
project - not null
Throws:
java.io.IOException - if any

writeEarTask

public static void writeEarTask(org.codehaus.plexus.util.xml.XMLWriter writer,
                                org.apache.maven.project.MavenProject project,
                                ArtifactResolverWrapper artifactResolverWrapper)
                         throws java.io.IOException
Convenience method to write XML Ant ear task

Parameters:
writer - not null
project - not null
artifactResolverWrapper - not null
Throws:
java.io.IOException - if any

writeWarTask

public static void writeWarTask(org.codehaus.plexus.util.xml.XMLWriter writer,
                                org.apache.maven.project.MavenProject project,
                                ArtifactResolverWrapper artifactResolverWrapper)
                         throws java.io.IOException
Convenience method to write XML Ant war task

Parameters:
writer - not null
project - not null
artifactResolverWrapper - not null
Throws:
java.io.IOException - if any

addWrapAttribute

public static void addWrapAttribute(org.codehaus.plexus.util.xml.XMLWriter writer,
                                    java.lang.String tag,
                                    java.lang.String name,
                                    java.lang.String value,
                                    int indent)
Convenience method to wrap long element tags for a given attribute.

Parameters:
writer - not null
tag - not null
name - not null
value - not null
indent - positive value

isPomPackaging

public static boolean isPomPackaging(org.apache.maven.project.MavenProject mavenProject)
Parameters:
mavenProject - not null
Returns:
true if project packaging equals pom

isJarPackaging

public static boolean isJarPackaging(org.apache.maven.project.MavenProject mavenProject)
Parameters:
mavenProject -
Returns:
true if project packaging equals one of several packaging types including jar, maven-plugin, ejb, or bundle

isBundlePackaging

public static boolean isBundlePackaging(org.apache.maven.project.MavenProject mavenProject)
Parameters:
mavenProject -
Returns:
true if project packaging equals bundle

isEjbPackaging

public static boolean isEjbPackaging(org.apache.maven.project.MavenProject mavenProject)
Parameters:
mavenProject -
Returns:
true if project packaging equals ejb

isMavenPluginPackaging

public static boolean isMavenPluginPackaging(org.apache.maven.project.MavenProject mavenProject)
Parameters:
mavenProject -
Returns:
true if project packaging equals maven-plugin

isEarPackaging

public static boolean isEarPackaging(org.apache.maven.project.MavenProject mavenProject)
Parameters:
mavenProject -
Returns:
true if project packaging equals ear

isWarPackaging

public static boolean isWarPackaging(org.apache.maven.project.MavenProject mavenProject)
Parameters:
mavenProject - not null
Returns:
true if project packaging equals war

getMavenCompilerPluginBasicOption

public static java.lang.String getMavenCompilerPluginBasicOption(org.apache.maven.project.MavenProject project,
                                                                 java.lang.String optionName,
                                                                 java.lang.String defaultValue)
                                                          throws java.io.IOException
Return the optionName value defined in a project for the "maven-compiler-plugin" plugin.

Parameters:
project - not null
optionName - the option name wanted
defaultValue - a default value
Returns:
the value for the option name or the default value. Could be null if not found.
Throws:
java.io.IOException - if any

getMavenCompilerPluginOption

public static java.util.Map getMavenCompilerPluginOption(org.apache.maven.project.MavenProject project,
                                                         java.lang.String optionName,
                                                         java.lang.String defaultValue)
                                                  throws java.io.IOException
Return the map of optionName value defined in a project for the "maven-compiler-plugin" plugin.

Parameters:
project - not null
optionName - the option name wanted
defaultValue - a default value
Returns:
the map for the option name or the default value. Could be null if not found.
Throws:
java.io.IOException - if any

getMavenCompilerPluginOptions

public static java.util.Map[] getMavenCompilerPluginOptions(org.apache.maven.project.MavenProject project,
                                                            java.lang.String optionName,
                                                            java.lang.String defaultValue)
                                                     throws java.io.IOException
Return an array of map of optionName value defined in a project for the "maven-compiler-plugin" plugin.

Parameters:
project - not null
optionName - the option name wanted
defaultValue - a default value
Returns:
the array of option name or the default value. Could be null if not found.
Throws:
java.io.IOException - if any

getMavenSurefirePluginBasicOption

public static java.lang.String getMavenSurefirePluginBasicOption(org.apache.maven.project.MavenProject project,
                                                                 java.lang.String optionName,
                                                                 java.lang.String defaultValue)
                                                          throws java.io.IOException
Return the optionName value defined in a project for the "maven-surefire-plugin" plugin.

Parameters:
project - not null
optionName - the option name wanted
defaultValue - a default value
Returns:
the value for the option name or the default value. Could be null if not found.
Throws:
java.io.IOException - if any

getMavenSurefirePluginOption

public static java.util.Map getMavenSurefirePluginOption(org.apache.maven.project.MavenProject project,
                                                         java.lang.String optionName,
                                                         java.lang.String defaultValue)
                                                  throws java.io.IOException
Return the map of optionName value defined in a project for the "maven-surefire-plugin" plugin.

Parameters:
project - not null
optionName - the option name wanted
defaultValue - a default value
Returns:
the map for the option name or the default value. Could be null if not found.
Throws:
java.io.IOException - if any

getMavenSurefirePluginOptions

public static java.util.Map[] getMavenSurefirePluginOptions(org.apache.maven.project.MavenProject project,
                                                            java.lang.String optionName,
                                                            java.lang.String defaultValue)
                                                     throws java.io.IOException
Return an array of map of optionName value defined in a project for the "maven-surefire-plugin" plugin.

Parameters:
project - not null
optionName - the option name wanted
defaultValue - a default value
Returns:
the array of option name or the default value. Could be null if not found.
Throws:
java.io.IOException - if any

getMavenJavadocPluginBasicOption

public static java.lang.String getMavenJavadocPluginBasicOption(org.apache.maven.project.MavenProject project,
                                                                java.lang.String optionName,
                                                                java.lang.String defaultValue)
                                                         throws java.io.IOException
Return the optionName value defined in a project for the "maven-javadoc-plugin" plugin.

Parameters:
project - not null
optionName - the option name wanted
defaultValue - a default value
Returns:
the value for the option name or the default value. Could be null if not found.
Throws:
java.io.IOException - if any

getMavenJavadocPluginOption

public static java.util.Map getMavenJavadocPluginOption(org.apache.maven.project.MavenProject project,
                                                        java.lang.String optionName,
                                                        java.lang.String defaultValue)
                                                 throws java.io.IOException
Return a map of optionName value defined in a project for the "maven-javadoc-plugin" plugin.

Parameters:
project - not null
optionName - the option name wanted
defaultValue - a default value
Returns:
the map for the option name or the default value. Could be null if not found.
Throws:
java.io.IOException - if any

getMavenJavadocPluginOptions

public static java.util.Map[] getMavenJavadocPluginOptions(org.apache.maven.project.MavenProject project,
                                                           java.lang.String optionName,
                                                           java.lang.String defaultValue)
                                                    throws java.io.IOException
Return an array of map of optionName value defined in a project for the "maven-javadoc-plugin" plugin.

Parameters:
project - not null
optionName - the option name wanted
defaultValue - a default value
Returns:
an array of option name. Could be null if not found.
Throws:
java.io.IOException - if any

getMavenJarPluginBasicOption

public static java.lang.String getMavenJarPluginBasicOption(org.apache.maven.project.MavenProject project,
                                                            java.lang.String optionName,
                                                            java.lang.String defaultValue)
                                                     throws java.io.IOException
Return the optionName value defined in a project for the "maven-jar-plugin" plugin.

Parameters:
project - not null
optionName - the option name wanted
defaultValue - a default value
Returns:
the value for the option name or the default value. Could be null if not found.
Throws:
java.io.IOException - if any

getMavenEarPluginBasicOption

public static java.lang.String getMavenEarPluginBasicOption(org.apache.maven.project.MavenProject project,
                                                            java.lang.String optionName,
                                                            java.lang.String defaultValue)
                                                     throws java.io.IOException
Return the optionName value defined in a project for the "maven-ear-plugin" plugin.

Parameters:
project - not null
optionName - the option name wanted
defaultValue - a default value
Returns:
the value for the option name or the default value. Could be null if not found.
Throws:
java.io.IOException - if any

getMavenWarPluginBasicOption

public static java.lang.String getMavenWarPluginBasicOption(org.apache.maven.project.MavenProject project,
                                                            java.lang.String optionName,
                                                            java.lang.String defaultValue)
                                                     throws java.io.IOException
Return the optionName value defined in a project for the "maven-war-plugin" plugin.

Parameters:
project - not null
optionName - the option name wanted
defaultValue - a default value
Returns:
the value for the option name or the default value. Could be null if not found.
Throws:
java.io.IOException - if any


Copyright © 2002-2010 Apache Software Foundation. All Rights Reserved.