org.apache.maven.plugin.ide
Class IdeUtils

java.lang.Object
  org.apache.maven.plugin.ide.IdeUtils

public class IdeUtils
extends java.lang.Object

Version:

$Id: IdeUtils.java 574764 2007-09-12 01:59:55Z brianf $

Author:

Trygve Laugstøl, Fabrizio Giustina

Field Summary

static java.lang.String	JAVA_1_1
static java.lang.String	JAVA_1_2
static java.lang.String	JAVA_1_3
static java.lang.String	JAVA_1_4
static java.lang.String	JAVA_5_0
static java.lang.String	JAVA_6_0
static java.lang.String	PROJECT_NAME_DEFAULT_TEMPLATE
static java.lang.String	PROJECT_NAME_WITH_GROUP_AND_VERSION_TEMPLATE
static java.lang.String	PROJECT_NAME_WITH_GROUP_TEMPLATE
static java.lang.String	PROJECT_NAME_WITH_VERSION_TEMPLATE

Method Summary

static java.lang.String	getCanonicalPath(java.io.File file)
static java.lang.String	getCompilerPluginSetting(org.apache.maven.project.MavenProject project, java.lang.String optionName) Returns a compiler plugin settings, considering also settings altered in plugin executions .
static java.lang.String	getCompilerSourceVersion(org.apache.maven.project.MavenProject project) Returns the source version configured for the compiler plugin.
static java.lang.String	getCompilerTargetVersion(org.apache.maven.project.MavenProject project) Returns the target version configured for the compiler plugin.
static java.lang.String	getDependencyVersion(java.lang.String[] artifactIds, java.util.List dependencies, int len) Extracts the version of the first matching dependency in the given list.
static java.lang.String	getPluginSetting(org.apache.maven.project.MavenProject project, java.lang.String artifactId, java.lang.String optionName, java.lang.String defaultValue)
static java.lang.String	getProjectName(IdeDependency dep, boolean addVersionToProjectName)
static java.lang.String	getProjectName(org.apache.maven.project.MavenProject project, boolean addVersionToProjectName)
static java.lang.String	getProjectName(java.lang.String template, org.apache.maven.artifact.Artifact artifact) Use the project name template to create an eclipse project.
static java.lang.String	getProjectName(java.lang.String template, IdeDependency dep)
static java.lang.String	getProjectName(java.lang.String template, org.apache.maven.project.MavenProject project)
static org.apache.maven.artifact.Artifact	resolveArtifactWithClassifier(java.lang.String groupId, java.lang.String artifactId, java.lang.String version, java.lang.String classifier, org.apache.maven.artifact.repository.ArtifactRepository localRepository, org.apache.maven.artifact.resolver.ArtifactResolver artifactResolver, org.apache.maven.artifact.factory.ArtifactFactory artifactFactory, java.util.List remoteRepos, org.apache.maven.plugin.logging.Log log)
static java.lang.String	resolveEjbVersion(org.apache.maven.project.MavenProject project) Deprecated. Use JeeUtils.resolveEjbVersion(MavenProject) instead
static java.lang.String	resolveJ2eeVersion(org.apache.maven.project.MavenProject project) Deprecated. Use JeeUtils.resolveJeeVersion(MavenProject) instead
static java.lang.String	resolveJavaVersion(org.apache.maven.project.MavenProject project)
static java.lang.String	resolveServletVersion(org.apache.maven.project.MavenProject project) Deprecated. Use JeeUtils.resolveServletVersion(MavenProject) instead
static java.lang.String	toRelativeAndFixSeparator(java.io.File basedir, java.io.File fileToAdd, boolean replaceSlashesWithDashes)

Methods inherited from class java.lang.Object

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

Field Detail

JAVA_1_1

public static final java.lang.String JAVA_1_1

See Also:

Constant Field Values

JAVA_1_2

public static final java.lang.String JAVA_1_2

See Also:

Constant Field Values

JAVA_1_3

public static final java.lang.String JAVA_1_3

See Also:

Constant Field Values

JAVA_1_4

public static final java.lang.String JAVA_1_4

See Also:

Constant Field Values

JAVA_5_0

public static final java.lang.String JAVA_5_0

See Also:

Constant Field Values

JAVA_6_0

public static final java.lang.String JAVA_6_0

See Also:

Constant Field Values

PROJECT_NAME_DEFAULT_TEMPLATE

public static final java.lang.String PROJECT_NAME_DEFAULT_TEMPLATE

See Also:

Constant Field Values

PROJECT_NAME_WITH_VERSION_TEMPLATE

public static final java.lang.String PROJECT_NAME_WITH_VERSION_TEMPLATE

See Also:

Constant Field Values

PROJECT_NAME_WITH_GROUP_TEMPLATE

public static final java.lang.String PROJECT_NAME_WITH_GROUP_TEMPLATE

See Also:

Constant Field Values

PROJECT_NAME_WITH_GROUP_AND_VERSION_TEMPLATE

public static final java.lang.String PROJECT_NAME_WITH_GROUP_AND_VERSION_TEMPLATE

See Also:

Constant Field Values

Method Detail

getCanonicalPath

public static java.lang.String getCanonicalPath(java.io.File file)
                                         throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getCompilerPluginSetting

public static java.lang.String getCompilerPluginSetting(org.apache.maven.project.MavenProject project,
                                                        java.lang.String optionName)

Returns a compiler plugin settings, considering also settings altered in plugin executions .

Parameters:

project - maven project

Returns:

option value (may be null)

getCompilerSourceVersion

public static java.lang.String getCompilerSourceVersion(org.apache.maven.project.MavenProject project)

Returns the source version configured for the compiler plugin. Returns the minimum version required to compile both standard and test sources, if settings are different.

Parameters:

project - maven project

Returns:

java source version

getCompilerTargetVersion

public static java.lang.String getCompilerTargetVersion(org.apache.maven.project.MavenProject project)

Returns the target version configured for the compiler plugin. Returns the minimum version required to compile both standard and test sources, if settings are different.

Parameters:

project - maven project

Returns:

java target version

getDependencyVersion

public static java.lang.String getDependencyVersion(java.lang.String[] artifactIds,
                                                    java.util.List dependencies,
                                                    int len)

Extracts the version of the first matching dependency in the given list.

Parameters:

artifactIds - artifact names to compare against for extracting version

dependencies - Collection of dependencies for our project

len - expected length of the version sub-string

Returns:

getPluginSetting

public static java.lang.String getPluginSetting(org.apache.maven.project.MavenProject project,
                                                java.lang.String artifactId,
                                                java.lang.String optionName,
                                                java.lang.String defaultValue)

getProjectName

public static java.lang.String getProjectName(java.lang.String template,
                                              IdeDependency dep)

getProjectName

public static java.lang.String getProjectName(java.lang.String template,
                                              org.apache.maven.artifact.Artifact artifact)

Use the project name template to create an eclipse project.

Parameters:

template - Template for the project name

artifact - the artifact to create the project name for

Returns:

the created ide project name

getProjectName

public static java.lang.String getProjectName(java.lang.String template,
                                              org.apache.maven.project.MavenProject project)

getProjectName

public static java.lang.String getProjectName(IdeDependency dep,
                                              boolean addVersionToProjectName)

getProjectName

public static java.lang.String getProjectName(org.apache.maven.project.MavenProject project,
                                              boolean addVersionToProjectName)

resolveArtifactWithClassifier

public static org.apache.maven.artifact.Artifact resolveArtifactWithClassifier(java.lang.String groupId,
                                                                               java.lang.String artifactId,
                                                                               java.lang.String version,
                                                                               java.lang.String classifier,
                                                                               org.apache.maven.artifact.repository.ArtifactRepository localRepository,
                                                                               org.apache.maven.artifact.resolver.ArtifactResolver artifactResolver,
                                                                               org.apache.maven.artifact.factory.ArtifactFactory artifactFactory,
                                                                               java.util.List remoteRepos,
                                                                               org.apache.maven.plugin.logging.Log log)

resolveEjbVersion

public static java.lang.String resolveEjbVersion(org.apache.maven.project.MavenProject project)

Deprecated. Use JeeUtils.resolveEjbVersion(MavenProject) instead

resolveJ2eeVersion

public static java.lang.String resolveJ2eeVersion(org.apache.maven.project.MavenProject project)

Deprecated. Use JeeUtils.resolveJeeVersion(MavenProject) instead

resolveJavaVersion

public static java.lang.String resolveJavaVersion(org.apache.maven.project.MavenProject project)

resolveServletVersion

public static java.lang.String resolveServletVersion(org.apache.maven.project.MavenProject project)

Deprecated. Use JeeUtils.resolveServletVersion(MavenProject) instead

toRelativeAndFixSeparator

public static java.lang.String toRelativeAndFixSeparator(java.io.File basedir,
                                                         java.io.File fileToAdd,
                                                         boolean replaceSlashesWithDashes)
                                                  throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException