ConsoleLogger Class Reference

Inheritance diagram for ConsoleLogger:

Collaboration diagram for ConsoleLogger:

Class Description

---

A logger that logs all messages to the Java console using System.out.print() or alternatively (if available) the PrintWriter object returned by System.console(). The latter is used if it is available and will lead to a different character encoding (typically on Windows operating system). The configuration variable ALOX_USE_SYSTEM_OUT_PRINT can be used to force the use of System.out..

The name of the Logger defaults to "CONSOLE".

Public Fields
PrintWriter	writer
Public Fields inherited from PlainTextLogger
boolean	pruneESCSequences = true
Public Fields inherited from TextLogger
AutoSizes	autoSizes = new AutoSizes()
ObjectConverter	converter
String	fmtMsgSuffix =""
String	fmtMultiLineMsgHeadline ="ALox: Multi line message follows: "
String	fmtMultiLinePrefix = ">> "
String	fmtMultiLineSuffix = null
MetaInfo	metaInfo = new MetaInfo()
String	multiLineDelimiter = null
String	multiLineDelimiterRepl = "\\r"
int	multiLineMsgMode = 2
Public Fields inherited from Logger
int	cntLogs
Ticks	timeOfCreation = new Ticks()
Ticks	timeOfLastLog = new Ticks()
Public Fields inherited from ThreadLock
int	recursionWarningThreshold = 10
int	waitWarningTimeLimitInMillis = 1000

Public Methods
	ConsoleLogger ()
	ConsoleLogger (String name)
Public Methods inherited from TextLogger
int	addAcquirer (ThreadLock newAcquirer)
void	clearReplacements ()
void	log (Domain domain, Verbosity verbosity, ArrayList< Object > logables, ScopeInfo scope)
int	removeAcquirer (ThreadLock acquirer)
void	resetAutoSizes ()
void	setReplacement (String searched, String replacement)
Public Methods inherited from Logger
String	getName ()
String	getTypeName ()
String	toString ()
Public Methods inherited from SmartLock
	SmartLock ()
int	cntAcquirers ()
Public Methods inherited from ThreadLock
	ThreadLock ()
	ThreadLock (LockMode lockMode)
	ThreadLock (LockMode lockMode, Safeness safeness)
void	acquire ()
int	dbgCountAcquirements (Thread thread)
LockMode	getMode ()
Safeness	getSafeness ()
void	release ()
void	setSafeness (Safeness safeness)
boolean	willRelease ()

Protected Methods
void	constructor ()
boolean	logSubstring (AString buffer, int start, int length)
boolean	notifyLogOp (Phase phase)
void	notifyMultiLineOp (Phase phase)
Protected Methods inherited from PlainTextLogger
	PlainTextLogger (String name, String typeName, boolean usesStdStreams)
void	logText (Domain domain, Verbosity verbosity, AString msg, ScopeInfo scope, int lineNumber)
Protected Methods inherited from TextLogger
	TextLogger (String name, String typeName, boolean usesStdStreams)
Protected Methods inherited from Logger
	Logger (String name, String typeName)

Additional Inherited Members
Protected Fields inherited from TextLogger
AString	logBuf = new AString( 256 )
AString	msgBuf = new AString( 128 )
ArrayList< String >	replacements = new ArrayList<String>()
int	stdStreamLockRegistrationCounter =0
boolean	usesStdStreams
Protected Fields inherited from Logger
String	name
String	typeName
Protected Fields inherited from SmartLock
ArrayList< ThreadLock >	acquirers = new ArrayList<ThreadLock>()
Protected Fields inherited from ThreadLock
int	cntAcquirements
boolean	createOwnerStackTrace = false
LockMode	lockMode
Object	mutex
Thread	owner
Exception	ownerException
Ticks	waitTime = new Ticks()
Package Access Methods inherited from ThreadLock
void	constructor (LockMode lockMode, Safeness safeness)

Constructor & Destructor Documentation

ConsoleLogger() [1/2]

ConsoleLogger

(

String

name

)

---

Creates a ConsoleLogger with the given name.

Parameters

name	The name of the Logger, defaults to "CONSOLE".

ConsoleLogger() [2/2]

ConsoleLogger

(

)

---

Creates a ConsoleLogger with the name "CONSOLE".

Member Function Documentation

constructor()

void constructor ( )

protected

---

Used by the constructors to perform common initialization tasks.

logSubstring()

boolean logSubstring ( AString  buffer, int  start, int  length  )

protected

---

Write the given region of the given AString to the destination buffer.

Parameters

buffer	The string to write a portion of.
start	The start of the portion in buffer to write out.
length	The length of the portion in buffer to write out.

Returns

Always returns true.

Reimplemented from PlainTextLogger.

notifyLogOp()

boolean notifyLogOp ( Phase  phase )

protected

---

Start a new log line. Appends a new-line character sequence to previously logged lines.

Parameters

phase

Indicates the beginning or end of a log operation.

Returns

Always returns true.

Reimplemented from PlainTextLogger.

notifyMultiLineOp()

void notifyMultiLineOp ( Phase  phase )

protected

---

Empty, not needed here

Parameters

phase

Indicates the beginning or end of a multi-line operation.

Reimplemented from TextLogger.

Member Data Documentation

writer

PrintWriter writer

Retrieved using System.console().writer(). See class description for more information.

Can also be set from outside to redirect output to any PrintWriter type.

---

The documentation for this class was generated from the following file:

• ConsoleLogger.java