choco.kernel.common.logging
Class ChocoLogging

java.lang.Object
  extended by choco.kernel.common.logging.ChocoLogging

public final class ChocoLogging
extends Object

A final class which handles choco logging statements. Most of choco class propose a static final field LOGGER.

Since:
16 avr. 2009 version 2.0.3
Version:
2.0.3
Author:
Arnaud Malapert

Field Summary
static Logger[] CHOCO_LOGGERS
           
static Handler DEFAULT_HANDLER
           
static Formatter DETAILED_FORMATTER
           
static Handler DETAILED_HANDLER
           
static Handler ERROR_HANDLER
           
static Formatter LIGHT_FORMATTER
           
static String START_MESSAGE
           
 
Method Summary
static OutputStream addErrorFileHandler(File file)
          add a new handler whichs receive error logs
static OutputStream addFileHandler(File file)
          add a new handler whichs receive logs
static OutputStream addFileHandler(File file, Level level, Formatter formatter)
           
protected static void addHandler(Handler handler, Logger... loggers)
           
protected static void clearHandlers()
           
protected static void clearHandlers(Logger logger)
           
static void flushLog(Logger logger)
           
static void flushLogs()
          flush pending logs
protected static Logger getAPILogger()
           
static Logger getBranchingLogger()
           
protected static Logger getChocoLogger()
           
protected static Logger getCoreLogger()
           
static Formatter getDefaultFormatter()
           
static Logger getEngineLogger()
           
static int getEveryXNodes()
           
static int getLoggingMaxDepth()
          get the maximal search depth for logging statements
static Logger getMainLogger()
           
static Logger getSearchLogger()
           
static Logger getTestLogger()
           
static void main(String[] args)
           
static Logger makeUserLogger(String name)
          create a new user logger with valid name
static void setDefaultHandler()
          set the default handler (out and err) for all loggers
static OutputStream setErrorFileHandler(File file)
          remove handlers and write error logs into a file (warning and severe message)
static void setEveryXNodes(int everyXnodes)
           
static OutputStream setFileHandler(File file)
          remove handlers and write logs into a file
static OutputStream setFileHandler(File file, Level level, Formatter formatter)
           
static void setHandler(Logger logger, Handler handler)
          remove other handlers and set the only handler for this logger
static void setLevel(Level level, Handler... handlers)
           
static void setLevel(Level level, Logger... loggers)
           
static void setLevel(Level level, Logger logger)
           
static void setLoggingMaxDepth(int loggingMaxDepth)
          set the maximal search depth for logging statements
static void setVerbosity(Verbosity verbosity)
          set the choco verbosity level
static void toDefault()
          Set verbosity to DEFAULT (syntaxic sugar)
static String toDotty()
           
static void toQuiet()
          Set verbosity to QUIET (syntaxic sugar)
static void toSearch()
          Set verbosity to SEARCH (syntaxic sugar)
static void toSilent()
          Set verbosity to SILENT (syntaxic sugar)
static void toSolution()
          Set verbosity to SOLUTION (syntaxic sugar)
static void toVerbose()
          Set verbosity to SILENT (syntaxic sugar)
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

START_MESSAGE

public static final String START_MESSAGE
See Also:
Constant Field Values

LIGHT_FORMATTER

public static final Formatter LIGHT_FORMATTER

DETAILED_FORMATTER

public static final Formatter DETAILED_FORMATTER

DEFAULT_HANDLER

public static final Handler DEFAULT_HANDLER

DETAILED_HANDLER

public static final Handler DETAILED_HANDLER

ERROR_HANDLER

public static final Handler ERROR_HANDLER

CHOCO_LOGGERS

public static final Logger[] CHOCO_LOGGERS
Method Detail

getEveryXNodes

public static final int getEveryXNodes()

setEveryXNodes

public static final void setEveryXNodes(int everyXnodes)

setLoggingMaxDepth

public static final void setLoggingMaxDepth(int loggingMaxDepth)
set the maximal search depth for logging statements


getLoggingMaxDepth

public static final int getLoggingMaxDepth()
get the maximal search depth for logging statements


makeUserLogger

public static Logger makeUserLogger(String name)
create a new user logger with valid name

Parameters:
name -
Returns:

getChocoLogger

protected static Logger getChocoLogger()

getCoreLogger

protected static Logger getCoreLogger()

getEngineLogger

public static Logger getEngineLogger()

getSearchLogger

public static Logger getSearchLogger()

getBranchingLogger

public static Logger getBranchingLogger()

getAPILogger

protected static Logger getAPILogger()

getMainLogger

public static Logger getMainLogger()

getTestLogger

public static Logger getTestLogger()

getDefaultFormatter

public static Formatter getDefaultFormatter()

flushLog

public static void flushLog(Logger logger)

flushLogs

public static void flushLogs()
flush pending logs


clearHandlers

protected static void clearHandlers()

clearHandlers

protected static void clearHandlers(Logger logger)

setDefaultHandler

public static void setDefaultHandler()
set the default handler (out and err) for all loggers


setLevel

public static void setLevel(Level level,
                            Handler... handlers)

setFileHandler

public static OutputStream setFileHandler(File file,
                                          Level level,
                                          Formatter formatter)

setErrorFileHandler

public static OutputStream setErrorFileHandler(File file)
remove handlers and write error logs into a file (warning and severe message)

Parameters:
file - the error log file
Returns:
the error stream

setFileHandler

public static OutputStream setFileHandler(File file)
remove handlers and write logs into a file

Parameters:
file - the log file
Returns:
the log stream

setHandler

public static void setHandler(Logger logger,
                              Handler handler)
remove other handlers and set the only handler for this logger


addHandler

protected static void addHandler(Handler handler,
                                 Logger... loggers)

addFileHandler

public static OutputStream addFileHandler(File file,
                                          Level level,
                                          Formatter formatter)

addErrorFileHandler

public static OutputStream addErrorFileHandler(File file)
add a new handler whichs receive error logs

Parameters:
file - the error log file
Returns:
the error stream

addFileHandler

public static OutputStream addFileHandler(File file)
add a new handler whichs receive logs

Parameters:
file - the log file
Returns:
the stream

setLevel

public static void setLevel(Level level,
                            Logger logger)

setLevel

public static void setLevel(Level level,
                            Logger... loggers)

toSilent

public static void toSilent()
Set verbosity to SILENT (syntaxic sugar)


toQuiet

public static void toQuiet()
Set verbosity to QUIET (syntaxic sugar)


toDefault

public static void toDefault()
Set verbosity to DEFAULT (syntaxic sugar)


toVerbose

public static void toVerbose()
Set verbosity to SILENT (syntaxic sugar)


toSolution

public static void toSolution()
Set verbosity to SOLUTION (syntaxic sugar)


toSearch

public static void toSearch()
Set verbosity to SEARCH (syntaxic sugar)


setVerbosity

public static void setVerbosity(Verbosity verbosity)
set the choco verbosity level

Parameters:
verbosity - the new verbosity level

toDotty

public static final String toDotty()

main

public static void main(String[] args)


Copyright © 2012. All Rights Reserved.