Package org.apache.maven.plugins.dependency.utils

Class DependencyUtil

java.lang.Object
org.apache.maven.plugins.dependency.utils.DependencyUtil
public final class DependencyUtil extends Object
Utility class with static helper methods.
Author:
Brian Fox

  • Constructor Summary

    Constructors
    Constructor
    Description
    DependencyUtil()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static String
    cleanToBeTokenizedString(String str)
    Clean up configuration string before it can be tokenized.
    static String
    getFormattedFileName(org.apache.maven.artifact.Artifact artifact, boolean removeVersion)
    Builds the file name.
    static String
    getFormattedFileName(org.apache.maven.artifact.Artifact artifact, boolean removeVersion, boolean prependGroupId)
    Builds the file name.
    static String
    getFormattedFileName(org.apache.maven.artifact.Artifact artifact, boolean removeVersion, boolean prependGroupId, boolean useBaseVersion)
    Builds the file name.
    static String
    getFormattedFileName(org.apache.maven.artifact.Artifact artifact, boolean removeVersion, boolean prependGroupId, boolean useBaseVersion, boolean removeClassifier)
    Builds the file name.
    static File
    getFormattedOutputDirectory(boolean useSubdirsPerScope, boolean useSubdirsPerType, boolean useSubdirPerArtifact, boolean useRepositoryLayout, boolean removeVersion, boolean removeType, File outputDirectory, org.apache.maven.artifact.Artifact artifact)
    Formats the outputDirectory based on type.
    static void
    log(String string, org.apache.maven.plugin.logging.Log log)
    Writes the specified string to the log at info level.
    static String[]
    tokenizer(String str)
    Mainly used to parse excludes, includes configuration.
    static void
    write(String string, File file, boolean append, String encoding)
    Writes the specified string to the specified file.
    static void
    write(String string, File file, boolean append, org.apache.maven.plugin.logging.Log log)
    Deprecated.
    specify an encoding instead of a log

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • DependencyUtil

      public DependencyUtil()

  • Method Details

    • getFormattedFileName

      public static String getFormattedFileName(org.apache.maven.artifact.Artifact artifact, boolean removeVersion)
      Builds the file name. If removeVersion is set, then the file name must be reconstructed from the artifactId, Classifier (if used) and Type. Otherwise, this method returns the artifact file name.
      Parameters:
      artifact - File to be formatted.
      removeVersion - Specifies if the version should be removed from the file name.
      Returns:
      Formatted file name in the format artifactId-[version]-[classifier].[type]
      See Also:

    • getFormattedFileName

      public static String getFormattedFileName(org.apache.maven.artifact.Artifact artifact, boolean removeVersion, boolean prependGroupId)
      Builds the file name. If removeVersion is set, then the file name must be reconstructed from the groupId (if prependGroupId is true) artifactId, Classifier (if used) and Type. Otherwise, this method returns the artifact file name.
      Parameters:
      artifact - File to be formatted.
      removeVersion - Specifies if the version should be removed from the file name.
      prependGroupId - Specifies if the groupId should be prepended to the file name.
      Returns:
      Formatted file name in the format [groupId].artifactId-[version]-[classifier].[type]

    • getFormattedFileName

      public static String getFormattedFileName(org.apache.maven.artifact.Artifact artifact, boolean removeVersion, boolean prependGroupId, boolean useBaseVersion)
      Builds the file name. If removeVersion is set, then the file name must be reconstructed from the groupId (if prependGroupId is true) artifactId, Classifier (if used), and Type. Otherwise, this method returns the artifact file name.
      Parameters:
      artifact - file to be formatted
      removeVersion - Specifies if the version should be removed from the file name
      prependGroupId - Specifies if the groupId should be prepended to the file name
      useBaseVersion - Specifies if the baseVersion of the artifact should be used instead of the version
      Returns:
      Formatted file name in the format [groupId].artifactId-[version]-[classifier].[type]

    • getFormattedFileName

      public static String getFormattedFileName(org.apache.maven.artifact.Artifact artifact, boolean removeVersion, boolean prependGroupId, boolean useBaseVersion, boolean removeClassifier)
      Builds the file name. If removeVersion is set, then the file name must be reconstructed from the groupId (if prependGroupId is true) artifactId, Classifier (if used) and Type. Otherwise, this method returns the artifact file name.
      Parameters:
      artifact - File to be formatted.
      removeVersion - Specifies if the version should be removed from the file name.
      prependGroupId - Specifies if the groupId should be prepended to the file name.
      useBaseVersion - Specifies if the baseVersion of the artifact should be used instead of the version.
      removeClassifier - Specifies if the classifier of the artifact should be remved from the file name.
      Returns:
      Formatted file name in the format [groupId].artifactId-[version]-[classifier].[type]

    • getFormattedOutputDirectory

      public static File getFormattedOutputDirectory(boolean useSubdirsPerScope, boolean useSubdirsPerType, boolean useSubdirPerArtifact, boolean useRepositoryLayout, boolean removeVersion, boolean removeType, File outputDirectory, org.apache.maven.artifact.Artifact artifact)
      Formats the outputDirectory based on type.
      Parameters:
      useSubdirsPerScope - if a new sub directory should be used for each scope.
      useSubdirsPerType - if a new sub directory should be used for each type.
      useSubdirPerArtifact - if a new sub directory should be used for each artifact.
      useRepositoryLayout - if dependencies must be moved into a Maven repository layout, if set, other settings will be ignored.
      removeVersion - if the version must not be mentioned in the filename
      removeType - if the type must not be mentioned in the filename
      outputDirectory - base outputDirectory.
      artifact - information about the artifact.
      Returns:
      a formatted File object to use for output.

    • write

      @Deprecated public static void write(String string, File file, boolean append, org.apache.maven.plugin.logging.Log log) throws IOException
      Deprecated.
      specify an encoding instead of a log
      Writes the specified string to the specified file.
      Parameters:
      string - the string to write
      file - the file to write to
      append - append to existing file or not
      log - ignored
      Throws:
      IOException - if an I/O error occurs

    • write

      public static void write(String string, File file, boolean append, String encoding) throws IOException
      Writes the specified string to the specified file.
      Parameters:
      string - the string to write
      file - the file to write to
      append - append to existing file or not
      encoding - character set name
      Throws:
      IOException - if an I/O error occurs

    • log

      public static void log(String string, org.apache.maven.plugin.logging.Log log) throws IOException
      Writes the specified string to the log at info level.
      Parameters:
      string - the string to write
      log - where to log information
      Throws:
      IOException - if an I/O error occurs

    • tokenizer

      public static String[] tokenizer(String str)
      Mainly used to parse excludes, includes configuration.
      Parameters:
      str - the string to split
      Returns:
      the result items

    • cleanToBeTokenizedString

      public static String cleanToBeTokenizedString(String str)
      Clean up configuration string before it can be tokenized.
      Parameters:
      str - the string which should be cleaned
      Returns:
      cleaned up string