org.objectweb.fractal.fraclet.doclets
Interface MonologHandlerTag

All Superinterfaces:
DocletTag, Serializable

public interface MonologHandlerTag
extends DocletTag

Class annotation describing a custom Monolog handler.

Version:
$Revision: 1.2 $
Author:
Romain Rouvoy
Annotation location:
class

Method Summary
 boolean getAppendMode()
          The append mode used.
 int getFileNumber()
          The maximal number of rolling files to use.
 int getMaxSize()
          The maximal size in bytes of the log file.
 String getName_()
          Provides the name of the handler.
 String getOutput()
          Provides the output to use.
 String getPattern()
          Provides the output pattern.
 String getType()
          Provides the Type of the handler.
 
Methods inherited from interface com.thoughtworks.qdox.model.DocletTag
getContext, getLineNumber, getName, getNamedParameter, getNamedParameterMap, getParameters, getValue
 

Method Detail

getName_

String getName_()
Provides the name of the handler.

Returns:
name of the handler.
Annotation argument mandatory.

getType

String getType()
Provides the Type of the handler.

Returns:
the type of the handler (default is Console).
Annotation argument default value:
Console

getOutput

String getOutput()
Provides the output to use.

Returns:
the output to use.
Annotation argument default value:
System.out

getPattern

String getPattern()
Provides the output pattern.

Returns:
the output pattern.
Annotation argument default value:
%l: %m%n

getMaxSize

int getMaxSize()
The maximal size in bytes of the log file.

Returns:
the maximal size in bytes of the log file to use.

getFileNumber

int getFileNumber()
The maximal number of rolling files to use.

Returns:
the maximal number of rolling files to use.

getAppendMode

boolean getAppendMode()
The append mode used.

Returns:
true if the appendMode flag is enabled.
Annotation argument default value:
false