org.apache.maven.plugin.coreit
Class AbstractLogMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.plugin.coreit.AbstractLogMojo

All Implemented Interfaces:

ContextEnabled, Mojo

Direct Known Subclasses:

LogSeparatorMojo, LogStringMojo, ResetMojo

public abstract class AbstractLogMojo
extends AbstractMojo

Provides common services for the mojos of this plugin.

Version:

$Id: AbstractLogMojo.java 723979 2008-12-06 13:25:46Z bentmann $

Author:

Benjamin Bentmann

Field Summary

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

AbstractLogMojo()

Method Summary

protected void	append(Object value) Appends the string representation of the specified object to the log file.
protected void	reset() Clears the contents of the log file by creating a new empty log file.

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.maven.plugin.Mojo

execute

Constructor Detail

AbstractLogMojo

public AbstractLogMojo()

Method Detail

append

protected void append(Object value)
               throws MojoExecutionException

Appends the string representation of the specified object to the log file. Logging null has no other effect than touching the file. For each value different from null, a line terminator will be appended to the value's string representation.

Parameters:

value - The object to log, may be null.

Throws:

MojoExecutionException - If the log file could not be updated.

reset

protected void reset()
              throws MojoExecutionException

Clears the contents of the log file by creating a new empty log file.

Throws:

MojoExecutionException - If the log file could not be reset.