Class FileLogger

java.lang.Object
org.apache.maven.shared.scriptinterpreter.FileLogger
All Implemented Interfaces:
ExecutionLogger

public class FileLogger extends Object implements ExecutionLogger
Version:
$Id: FileLogger.java 1389141 2012-09-23 20:29:01Z hboutemy $
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private File
    The path to the log file.
    private final org.apache.maven.plugin.logging.Log
    The optional mojo logger to additionally write messages to, can be null.
    private boolean
    A flag whether the output stream should be closed during finalization of this logger.
    private PrintStream
    The underlying file stream this logger writes to.
  • Constructor Summary

    Constructors
    Constructor
    Description
    FileLogger(File outputFile)
    Creates a new logger that writes to the specified file.
    FileLogger(File outputFile, org.apache.maven.plugin.logging.Log log)
    Creates a new logger that writes to the specified file and optionally mirrors messages to the given mojo logger.
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    Closes the underlying file stream.
    void
    Writes the specified line to the log file and optionally to the mojo logger.
    protected void
    Closes the underlying file stream.
    Gets the path to the output file.
    Gets the underlying stream used to write message to the log file.

    Methods inherited from class java.lang.Object

    clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • file

      private File file
      The path to the log file.
    • stream

      private PrintStream stream
      The underlying file stream this logger writes to.
    • shouldFinalize

      private boolean shouldFinalize
      A flag whether the output stream should be closed during finalization of this logger.
    • log

      private final org.apache.maven.plugin.logging.Log log
      The optional mojo logger to additionally write messages to, can be null.
  • Constructor Details

    • FileLogger

      public FileLogger(File outputFile) throws IOException
      Creates a new logger that writes to the specified file.
      Parameters:
      outputFile - The path to the output file, must not be null.
      Throws:
      IOException - If the output file could not be created.
    • FileLogger

      public FileLogger(File outputFile, org.apache.maven.plugin.logging.Log log) throws IOException
      Creates a new logger that writes to the specified file and optionally mirrors messages to the given mojo logger.
      Parameters:
      outputFile - The path to the output file, must not be null.
      log - The mojo logger to additionally output messages to, may be null if not used.
      Throws:
      IOException - If the output file could not be created.
  • Method Details

    • getOutputFile

      public File getOutputFile()
      Gets the path to the output file.
      Returns:
      The path to the output file, never null.
    • getPrintStream

      public PrintStream getPrintStream()
      Gets the underlying stream used to write message to the log file.
      Specified by:
      getPrintStream in interface ExecutionLogger
      Returns:
      The underlying stream used to write message to the log file, never null.
    • consumeLine

      public void consumeLine(String line)
      Writes the specified line to the log file and optionally to the mojo logger.
      Specified by:
      consumeLine in interface ExecutionLogger
      Parameters:
      line - The message to log.
    • close

      public void close()
      Closes the underlying file stream.
    • finalize

      protected void finalize()
      Closes the underlying file stream.
      Overrides:
      finalize in class Object