Package org.codehaus.plexus.build

Interface BuildContext

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int SEVERITY_ERROR
      Constant SEVERITY_ERROR=2
      static int SEVERITY_WARNING
      Constant SEVERITY_WARNING=1

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      void addError​(File file, int line, int column, String message, Throwable cause)
      Deprecated.
      Use addMessage with severity=SEVERITY_WARNING instead
      void addMessage​(File file, int line, int column, String message, int severity, Throwable cause)
      Adds a message to the build context.
      void addWarning​(File file, int line, int column, String message, Throwable cause)
      Deprecated.
      Use addMessage with severity=SEVERITY_ERROR instead
      Object getValue​(String key)
      Returns value associated with key during previous mojo execution.
      boolean hasDelta​(File file)
      Returns true if the file has changed since last build or is not under basedir.
      boolean hasDelta​(String relpath)
      Returns true if file or folder identified by relpath has changed since last build.
      boolean hasDelta​(List<String> relpaths)
      Returns true if any file or folder identified by relpaths has changed since last build.
      boolean isIncremental()
      Returns true if this build context is incremental.
      boolean isUptodate​(File target, File source)
      Returns true, if the target file exists and is uptodate compared to the source file.
      org.codehaus.plexus.util.Scanner newDeleteScanner​(File basedir)
      Returned Scanner scans basedir for files and directories deleted since last build.
      OutputStream newFileOutputStream​(File file)
      Returns new OutputStream that writes to the file.
      org.codehaus.plexus.util.Scanner newScanner​(File basedir)
      Convenience method, fully equal to newScanner(basedir, false)
      org.codehaus.plexus.util.Scanner newScanner​(File basedir, boolean ignoreDelta)
      Returned Scanner scans files and folders under basedir.
      void refresh​(File file)
      Indicates that the file or folder content has been modified during the build.
      void removeMessages​(File file)
      Removes all messages associated with a file or folder during a previous build.
      void setValue​(String key, Object value)
      Associate specified key with specified value in the build context.

    • Field Detail

      • SEVERITY_WARNING

        static final int SEVERITY_WARNING
        Constant SEVERITY_WARNING=1
        See Also:
        Constant Field Values

      • SEVERITY_ERROR

        static final int SEVERITY_ERROR
        Constant SEVERITY_ERROR=2
        See Also:
        Constant Field Values

    • Method Detail

      • hasDelta

        boolean hasDelta​(String relpath)
        Returns true if file or folder identified by relpath has changed since last build.
        Parameters:
        relpath - is path relative to build context basedir
        Returns:
        a boolean.

      • hasDelta

        boolean hasDelta​(File file)
        Returns true if the file has changed since last build or is not under basedir.
        Parameters:
        file - a File object.
        Returns:
        a boolean.
        Since:
        0.0.5

      • hasDelta

        boolean hasDelta​(List<String> relpaths)
        Returns true if any file or folder identified by relpaths has changed since last build.
        Parameters:
        relpaths - paths relative to build context basedir
        Returns:
        a boolean.

      • refresh

        void refresh​(File file)
        Indicates that the file or folder content has been modified during the build.
        Parameters:
        file - a File object.
        See Also:
        newFileOutputStream(File)

      • newFileOutputStream

        OutputStream newFileOutputStream​(File file)
                          throws IOException
        Returns new OutputStream that writes to the file. Files changed using OutputStream returned by this method do not need to be explicitly refreshed using refresh(File). As an optional optimisation, OutputStreams created by incremental build context will attempt to avoid writing to the file if file content has not changed.
        Parameters:
        file - a File object.
        Returns:
        a OutputStream object.
        Throws:
        IOException - if any.

      • newScanner

        org.codehaus.plexus.util.Scanner newScanner​(File basedir)
        Convenience method, fully equal to newScanner(basedir, false)
        Parameters:
        basedir - a File object.
        Returns:
        a Scanner object.

      • newDeleteScanner

        org.codehaus.plexus.util.Scanner newDeleteScanner​(File basedir)
        Returned Scanner scans basedir for files and directories deleted since last build. Returns empty Scanner if basedir is not under this build context basedir.
        Parameters:
        basedir - a File object.
        Returns:
        a Scanner object.

      • newScanner

        org.codehaus.plexus.util.Scanner newScanner​(File basedir,
                                            boolean ignoreDelta)
        Returned Scanner scans files and folders under basedir. If this is an incremental build context and ignoreDelta is false, the scanner will only "see" files and folders with content changes since last build. If ignoreDelta is true, the scanner will "see" all files and folders. Please beware that ignoreDelta=false does NOT work reliably for operations that copy resources from source to target locations. Returned Scanner only scans changed source resources and it does not consider changed or deleted target resources. This results in missing or stale target resources. Starting with 0.5.0, recommended way to process resources is to use #newScanner(basedir,true) to locate all source resources and isUptodate(File, File) to optimized processing of uptodate target resources. Returns empty Scanner if basedir is not under this build context basedir. https://issues.apache.org/jira/browse/MSHARED-125
        Parameters:
        basedir - a File object.
        ignoreDelta - a boolean.
        Returns:
        a Scanner object.

      • isIncremental

        boolean isIncremental()
        Returns true if this build context is incremental. Scanners created by newScanner(File) of an incremental build context will ignore files and folders that were not changed since last build. Additionally, newDeleteScanner(File) will scan files and directories deleted since last build.
        Returns:
        a boolean.

      • setValue

        void setValue​(String key,
              Object value)
        Associate specified key with specified value in the build context. Primary (and the only) purpose of this method is to allow preservation of state needed for proper incremental behaviour between consecutive executions of the same mojo needed to. For example, maven-plugin-plugin:descriptor mojo can store collection of extracted MojoDescritpor during first invocation. Then on each consecutive execution maven-plugin-plugin:descriptor will only need to extract MojoDescriptors for changed files.
        Parameters:
        key - a String object.
        value - a Object object.
        See Also:
        getValue(String)

      • getValue

        Object getValue​(String key)
        Returns value associated with key during previous mojo execution. This method always returns null for non-incremental builds (i.e., isIncremental() returns false) and mojos are expected to fall back to full, non-incremental behaviour.
        Parameters:
        key - a String object.
        Returns:
        a Object object.
        See Also:
        setValue(String, Object), isIncremental()

      • addWarning

        void addWarning​(File file,
                int line,
                int column,
                String message,
                Throwable cause)
        Deprecated.
        Use addMessage with severity=SEVERITY_ERROR instead

        addWarning.

        Parameters:
        file - a File object.
        line - a int.
        column - a int.
        message - a String object.
        cause - a Throwable object.
        Since:
        0.0.5

      • addError

        void addError​(File file,
              int line,
              int column,
              String message,
              Throwable cause)
        Deprecated.
        Use addMessage with severity=SEVERITY_WARNING instead

        addError.

        Parameters:
        file - a File object.
        line - a int.
        column - a int.
        message - a String object.
        cause - a Throwable object.
        Since:
        0.0.5

      • addMessage

        void addMessage​(File file,
                int line,
                int column,
                String message,
                int severity,
                Throwable cause)
        Adds a message to the build context. The message is associated with a file and a location inside that file.
        Parameters:
        file - The file or folder with which the message is associated. Should not be null and it is recommended to be an absolute path.
        line - The line number inside the file. Use 1 (not 0) for the first line. Use 0 for unknown/unspecified.
        column - The column number inside the file. Use 1 (not 0) for the first column. Use 0 for unknown/unspecified.
        severity - The severity of the message: SEVERITY_WARNING or SEVERITY_ERROR.
        cause - A Throwable object associated with the message. Can be null.
        message - a String object.
        Since:
        0.0.7

      • removeMessages

        void removeMessages​(File file)
        Removes all messages associated with a file or folder during a previous build. It does not affect the messages added during the current build.
        Parameters:
        file - a File object.
        Since:
        0.0.7

      • isUptodate

        boolean isUptodate​(File target,
                   File source)
        Returns true, if the target file exists and is uptodate compared to the source file. More specifically, this method returns true when both target and source files exist, do not have changes since last incremental build and the target file was last modified later than the source file. Returns false in all other cases.
        Parameters:
        target - a File object.
        source - a File object.
        Returns:
        a boolean.
        Since:
        0.0.5