public class IdeUtils
extends java.lang.Object
| Modifier and Type | Field and Description |
|---|---|
private static java.lang.String |
ARTIFACT_MAVEN_COMPILER_PLUGIN
compiler plugin id.
|
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 |
NOT_AVAILABLE_MARKER_FILE_SUFFIX
The suffix used to mark a file as not available.
|
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 |
private static java.lang.String |
PROPERTY_ENCODING
'encoding' property for maven-compiler-plugin.
|
private static java.lang.String |
PROPERTY_SOURCE
'source' property for maven-compiler-plugin.
|
private static java.lang.String |
PROPERTY_TARGET
'target' property for maven-compiler-plugin.
|
| Modifier | Constructor and Description |
|---|---|
private |
IdeUtils() |
| Modifier and Type | Method and Description |
|---|---|
static java.lang.String |
calculateProjectNameTemplate(java.lang.String projectNameTemplate,
boolean addVersionToProjectName,
boolean addGroupIdToProjectName,
org.apache.maven.plugin.logging.Log log)
Calculate the project name template from the specified value
projectNameTemplate,
addVersionToProjectName and addGroupIdToProjectName |
static org.apache.maven.artifact.Artifact |
createArtifactWithClassifier(java.lang.String groupId,
java.lang.String artifactId,
java.lang.String version,
java.lang.String depClassifier,
java.lang.String inClassifier,
org.apache.maven.artifact.factory.ArtifactFactory artifactFactory)
Wrap
ArtifactFactory.createArtifactWithClassifier(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String) so that the type and classifier are set correctly for
"sources" and "javadoc". |
static void |
delete(java.io.File f,
org.apache.maven.plugin.logging.Log log)
Delete a file, handling log messages and exceptions
|
private static java.lang.String |
findCompilerPluginSettingInPlugins(java.util.List plugins,
java.lang.String optionName)
Returns a compiler plugin settings from a list of plugins .
|
static java.lang.String |
fixSeparator(java.lang.String filename)
Convert the provided filename from a Windows separator \\ to a unix/java separator /
|
static java.lang.String |
fixWindowsDriveURI(java.lang.String input)
NOTE: This is to account for the unfortunate fact that "file:" URIs differ between Windows and Unix.
|
static org.apache.maven.artifact.versioning.ArtifactVersion |
getArtifactVersion(java.lang.String[] artifactIds,
java.util.List dependencies) |
static java.lang.String |
getArtifactVersion(java.lang.String[] artifactIds,
java.util.List dependencies,
int len)
Extracts the version of the first matching artifact in the given list.
|
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 |
getCompilerSourceEncoding(org.apache.maven.project.MavenProject project)
Returns the source encoding configured for the compiler plugin.
|
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.io.File |
getNotAvailableMarkerFile(org.apache.maven.artifact.repository.ArtifactRepository localRepository,
org.apache.maven.artifact.Artifact artifact) |
static org.codehaus.plexus.util.xml.Xpp3Dom |
getPluginConfigurationDom(org.apache.maven.project.MavenProject project,
java.lang.String pluginId)
Search for the configuration Xpp3 dom of an other plugin.
|
static org.codehaus.plexus.util.xml.Xpp3Dom[] |
getPluginConfigurationDom(org.apache.maven.project.MavenProject project,
java.lang.String artifactId,
java.lang.String[] subConfiguration)
Search for the configuration Xpp3 dom of an other plugin.
|
static java.lang.String |
getPluginSetting(org.apache.maven.project.MavenProject project,
java.lang.String pluginId,
java.lang.String optionName,
java.lang.String defaultValue)
Search for a configuration setting of an other plugin for a configuration setting.
|
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.
|
protected static java.lang.String |
getProjectName(java.lang.String template,
IdeDependency dep)
Use
IdeDependency.getEclipseProjectName() instead. |
static java.lang.String |
getProjectName(java.lang.String template,
org.apache.maven.project.MavenProject project) |
private static java.lang.String |
getProjectName(java.lang.String template,
java.lang.String groupId,
java.lang.String artifactId,
java.lang.String version) |
static org.apache.maven.artifact.Artifact |
resolveArtifact(org.apache.maven.artifact.resolver.ArtifactResolver artifactResolver,
org.apache.maven.artifact.Artifact artifact,
java.util.List remoteRepos,
org.apache.maven.artifact.repository.ArtifactRepository localRepository,
org.apache.maven.plugin.logging.Log log)
Wrapper around
ArtifactResolver.resolve(Artifact, List, ArtifactRepository) |
static java.lang.String |
resolveJavaVersion(org.apache.maven.project.MavenProject project) |
static java.lang.String |
toRelativeAndFixSeparator(java.io.File basedir,
java.io.File fileToAdd,
boolean replaceSlashesWithDashes) |
public static final java.lang.String JAVA_1_1
public static final java.lang.String JAVA_1_2
public static final java.lang.String JAVA_1_3
public static final java.lang.String JAVA_1_4
public static final java.lang.String JAVA_5_0
public static final java.lang.String JAVA_6_0
public static final java.lang.String PROJECT_NAME_DEFAULT_TEMPLATE
public static final java.lang.String PROJECT_NAME_WITH_VERSION_TEMPLATE
public static final java.lang.String PROJECT_NAME_WITH_GROUP_TEMPLATE
public static final java.lang.String PROJECT_NAME_WITH_GROUP_AND_VERSION_TEMPLATE
private static final java.lang.String ARTIFACT_MAVEN_COMPILER_PLUGIN
private static final java.lang.String PROPERTY_SOURCE
private static final java.lang.String PROPERTY_ENCODING
private static final java.lang.String PROPERTY_TARGET
public static final java.lang.String NOT_AVAILABLE_MARKER_FILE_SUFFIX
public static void delete(java.io.File f,
org.apache.maven.plugin.logging.Log log)
throws org.apache.maven.plugin.MojoExecutionException
f - File to be deletedorg.apache.maven.plugin.MojoExecutionException - only if a file exists and can't be deletedpublic static java.lang.String getCanonicalPath(java.io.File file)
throws org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoExecutionExceptionpublic static java.lang.String getCompilerPluginSetting(org.apache.maven.project.MavenProject project,
java.lang.String optionName)
project - maven projectpublic static java.lang.String getCompilerSourceVersion(org.apache.maven.project.MavenProject project)
project - maven projectpublic static java.lang.String getCompilerSourceEncoding(org.apache.maven.project.MavenProject project)
project - maven projectpublic static java.lang.String getCompilerTargetVersion(org.apache.maven.project.MavenProject project)
project - maven projectpublic static java.lang.String getArtifactVersion(java.lang.String[] artifactIds,
java.util.List dependencies,
int len)
The len parameter indicated what to to return:
major versionmajor dot minor versionmajor dot minor dot incremental version
artifactIds - artifact names to compare against for extracting versionartifacts - Set of artifacts for our projectlen - expected length of the version sub-stringpublic static org.apache.maven.artifact.versioning.ArtifactVersion getArtifactVersion(java.lang.String[] artifactIds,
java.util.List dependencies)
artifactIds - an array of artifactIds, should not be nulldependencies - a list of Dependency-objects, should not be nullnullpublic static java.lang.String getPluginSetting(org.apache.maven.project.MavenProject project,
java.lang.String pluginId,
java.lang.String optionName,
java.lang.String defaultValue)
project - the current maven project to get the configuration from.pluginId - the group id and artifact id of the plugin to search foroptionName - the option to get from the configurationdefaultValue - the default value if the configuration was not foundpublic static org.codehaus.plexus.util.xml.Xpp3Dom getPluginConfigurationDom(org.apache.maven.project.MavenProject project,
java.lang.String pluginId)
project - the current maven project to get the configuration from.pluginId - the group id and artifact id of the plugin to search forpublic static org.codehaus.plexus.util.xml.Xpp3Dom[] getPluginConfigurationDom(org.apache.maven.project.MavenProject project,
java.lang.String artifactId,
java.lang.String[] subConfiguration)
project - the current maven project to get the configuration from.artifactId - the artifact id of the plugin to search forpublic static java.lang.String calculateProjectNameTemplate(java.lang.String projectNameTemplate,
boolean addVersionToProjectName,
boolean addGroupIdToProjectName,
org.apache.maven.plugin.logging.Log log)
projectNameTemplate,
addVersionToProjectName and addGroupIdToProjectName
Note: if projectNameTemplate is not null then that value will be used regardless of the values for addVersionToProjectName or addGroupIdToProjectName and a warning will be issued.
projectNameTemplate - the current projectNameTemplate, if availableaddVersionToProjectName - whether to include Version in the project nameaddGroupIdToProjectName - whether to include GroupId in the project name.protected static java.lang.String getProjectName(java.lang.String template,
IdeDependency dep)
IdeDependency.getEclipseProjectName() instead.public static java.lang.String getProjectName(java.lang.String template,
org.apache.maven.artifact.Artifact artifact)
template - Template for the project nameartifact - the artifact to create the project name forpublic static java.lang.String getProjectName(java.lang.String template,
org.apache.maven.project.MavenProject project)
public static java.lang.String getProjectName(org.apache.maven.project.MavenProject project,
boolean addVersionToProjectName)
public static java.io.File getNotAvailableMarkerFile(org.apache.maven.artifact.repository.ArtifactRepository localRepository,
org.apache.maven.artifact.Artifact artifact)
artifact - the artifactpublic static org.apache.maven.artifact.Artifact resolveArtifact(org.apache.maven.artifact.resolver.ArtifactResolver artifactResolver,
org.apache.maven.artifact.Artifact artifact,
java.util.List remoteRepos,
org.apache.maven.artifact.repository.ArtifactRepository localRepository,
org.apache.maven.plugin.logging.Log log)
ArtifactResolver.resolve(Artifact, List, ArtifactRepository)artifactResolver - see ArtifactResolver.resolve(Artifact, List, ArtifactRepository)artifact - see ArtifactResolver.resolve(Artifact, List, ArtifactRepository)remoteRepos - see ArtifactResolver.resolve(Artifact, List, ArtifactRepository)localRepository - see ArtifactResolver.resolve(Artifact, List, ArtifactRepository)log - Loggerpublic static org.apache.maven.artifact.Artifact createArtifactWithClassifier(java.lang.String groupId,
java.lang.String artifactId,
java.lang.String version,
java.lang.String depClassifier,
java.lang.String inClassifier,
org.apache.maven.artifact.factory.ArtifactFactory artifactFactory)
ArtifactFactory.createArtifactWithClassifier(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String) so that the type and classifier are set correctly for
"sources" and "javadoc".groupId - see ArtifactFactory.createArtifactWithClassifier(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)artifactId - see ArtifactFactory.createArtifactWithClassifier(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)version - see ArtifactFactory.createArtifactWithClassifier(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)depClassifier - see ArtifactFactory.createArtifactWithClassifier(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)inClassifier - either "sources" of "javadoc"artifactFactory - see ArtifactFactory.createArtifactWithClassifier(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)ArtifactFactory.createArtifactWithClassifier(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)ArtifactFactory.createArtifactWithClassifier(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)public static java.lang.String resolveJavaVersion(org.apache.maven.project.MavenProject project)
public static java.lang.String toRelativeAndFixSeparator(java.io.File basedir,
java.io.File fileToAdd,
boolean replaceSlashesWithDashes)
throws org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoExecutionExceptionpublic static java.lang.String fixSeparator(java.lang.String filename)
filename - file name to fix separatorpublic static java.lang.String fixWindowsDriveURI(java.lang.String input)
input - string input that may contain a windows URIprivate static java.lang.String findCompilerPluginSettingInPlugins(java.util.List plugins,
java.lang.String optionName)
project - maven projectprivate static java.lang.String getProjectName(java.lang.String template,
java.lang.String groupId,
java.lang.String artifactId,
java.lang.String version)