Log (XMLmind Web Help Compiler Java[tm] API)

java.lang.Object
- com.xmlmind.util.Log

```
public final class Log
extends Object
```
A simple log facility which implements the following services:
- Log messages to a cyclic in-memory buffer.
- Access last logged messages.
- Clear last logged messages.
- List all the logs that have been created during a session.
In addition to the above services, this log facility can act as a facade for real logging tools such as those found in java.util.logging.Logger.
This class is thread-safe.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Log.Item` A buffered item.
`static class`	`Log.Level` Log levels.
`static interface`	`Log.Recorder` Underlying logger.
`static interface`	`Log.RecorderFactory` Underlying logger factory.
`static class`	`Log.RecorderFactoryImpl` Creates and returns `Log.RecorderImpl`s.
`static class`	`Log.RecorderImpl` A message recorder that does not nothing at.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_CAPACITY` Default buffering capacity (1,000).
`static int`	`MAX_CAPACITY` Maximum buffering capacity (100,000).
`Log.Recorder`	`recorder` The underlying logger used by this Log object.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Removes all buffered items.
`void`	`debug(String message)` Logs specified message at level `Log.Level.DEBUG`.
`void`	`error(String message)` Logs specified message at level `Log.Level.ERROR`.
`Log.Item[]`	`get()` Returns all buffered items.
`Log.Item[]`	`get(int maxCount)` Returns last buffered items.
`Log.Item[]`	`get(Log.Level maxLevel)` Returns all buffered items having at most specified level.
`Log.Item[]`	`get(Log.Level maxLevel, int maxCount)` Returns last buffered items having at most specified level.
`int`	`getCapacity()` Returns buffering capacity.
`static Log`	`getLog(String name)` Returns the log having specified name.
`static String[]`	`getNames()` Returns the names of all logs returned by `getLog(java.lang.String)`.
`static Log.RecorderFactory`	`getRecorderFactory()` Returns currently used RecorderFactory.
`void`	`info(String message)` Logs specified message at level `Log.Level.INFO`.
`void`	`log(Log.Level level, String message)` Logs specified message at specified level.
`void`	`print(boolean mostRecentFirst, boolean withDate, PrintStream out)` Prints all logged items to specified output stream.
`void`	`setCapacity(int capacity)` Specifies buffering capacity.
`static void`	`setRecorderFactory(Log.RecorderFactory factory)` Specifies which RecorderFactory to use.
`void`	`verbose(String message)` Logs specified message at level `Log.Level.VERBOSE`.
`void`	`warning(String message)` Logs specified message at level `Log.Level.WARNING`.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_CAPACITY
```
public static final int DEFAULT_CAPACITY
```
    Default buffering capacity (1,000).
    
    See Also:
    
    Constant Field Values
  - MAX_CAPACITY
```
public static final int MAX_CAPACITY
```
    Maximum buffering capacity (100,000).
    
    See Also:
    
    Constant Field Values
  - recorder
```
public final Log.Recorder recorder
```
    The underlying logger used by this Log object.
- Method Detail
  - setRecorderFactory
```
public static void setRecorderFactory(Log.RecorderFactory factory)
```
    Specifies which RecorderFactory to use. Specify null to use the default implementation.
  - getRecorderFactory
```
public static Log.RecorderFactory getRecorderFactory()
```
    Returns currently used RecorderFactory.
  - getLog
```
public static Log getLog(String name)
```
    Returns the log having specified name. Creates one if needed to.
    A log name may be anything string. However some related utilities support qualified names. A qualified name has the following syntax:
```
qualified_name -> [ namespace ]? local_part
namespace -> '{' [ string ]? '}'
local_part -> string
```
    Note that {}foo and foo are equivalent.
  - getNames
```
public static String[] getNames()
```
    Returns the names of all logs returned by getLog(java.lang.String).
  - error
```
public void error(String message)
```
    Logs specified message at level Log.Level.ERROR.
  - warning
```
public void warning(String message)
```
    Logs specified message at level Log.Level.WARNING.
  - info
```
public void info(String message)
```
    Logs specified message at level Log.Level.INFO.
  - verbose
```
public void verbose(String message)
```
    Logs specified message at level Log.Level.VERBOSE.
  - debug
```
public void debug(String message)
```
    Logs specified message at level Log.Level.DEBUG.
  - log
```
public void log(Log.Level level,
                String message)
```
    Logs specified message at specified level.
  - setCapacity
```
public void setCapacity(int capacity)
```
    Specifies buffering capacity. Cannot exceed MAX_CAPACITY.
    When the number of buffered items has reached this capacity, ``oldest''item is discarded to make room for newly buffered item.
  - getCapacity
```
public int getCapacity()
```
    Returns buffering capacity.
  - get
```
public Log.Item[] get()
```
    Returns all buffered items.
  - get
```
public Log.Item[] get(int maxCount)
```
    Returns last buffered items.
    
    Parameters:
    
    maxCount - return at most this number of items
    
    Returns:
    
    a possibly empty array of items, first item being the ``oldest one''
  - get
```
public Log.Item[] get(Log.Level maxLevel)
```
    Returns all buffered items having at most specified level.
    
    Parameters:
    
    maxLevel - maximum level (inclusive) for returned items
    
    Returns:
    
    a possibly empty array of items, first item being the ``oldest one''
  - get
```
public Log.Item[] get(Log.Level maxLevel,
                      int maxCount)
```
    Returns last buffered items having at most specified level.
    
    Parameters:
    
    maxLevel - maximum level (inclusive) for returned items
    
    maxCount - return at most this number of items
    
    Returns:
    
    a possibly empty array of items, first item being the ``oldest one''
  - clear
```
public void clear()
```
    Removes all buffered items.
  - print
```
public void print(boolean mostRecentFirst,
                  boolean withDate,
                  PrintStream out)
```
    Prints all logged items to specified output stream.
    
    Parameters:
    
    mostRecentFirst - if true, print most recently logged items first; if false, print items in the order in which they have been logged
    
    withDate - if true, each printed line starts with the log date of the item
    
    out - output stream

Class Log

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_CAPACITY

MAX_CAPACITY

recorder

Method Detail

setRecorderFactory

getRecorderFactory

getLog

getNames

error

warning

info

verbose

debug

log

setCapacity

getCapacity

get

get

get

get

clear

print