Log (flex-messaging-common 4.7.0 API)

java.lang.Object
- flex.messaging.log.Log

```
public class Log
extends Object
```

Field Summary

Fields
Modifier and Type Field and Description

static String INVALID_CHARS

static String VALUE_SUPRESSED

Fields
Modifier and Type	Field and Description
`static String`	`INVALID_CHARS`
`static String`	`VALUE_SUPRESSED`

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`addTarget(Target target)` Adds a target to the log.
`static boolean`	`checkFilterToCategory(String filter, String category)` Check whether the category match with the filter.
`static void`	`clear()` Clean up static member variables.
`static Log`	`createLog()` Creates the log on first access, returns already created log on subsequent calls.
`static void`	`flush()`
`static Logger`	`getLogger(Log log, String category)`
`static Logger`	`getLogger(String category)` Given a category, returns the logger associated with the category.
`String[]`	`getLoggers()` Return the categories for all of the loggers
`static PrettyPrinter`	`getPrettyPrinter()`
`static Target`	`getTarget(String searchId)` Returns the target associated with the unique ID searchId.
`static short`	`getTargetLevel()`
`static Map`	`getTargetMap()` Return the Log's map of targets keyed on their human-readable ids (e.g.
`static List`	`getTargets()` Returns an unmodifiable snapshot of the targets registered with this Log when the method is invoked.
`static boolean`	`hasIllegalCharacters(String value)`
`static void`	`initialize(String id, ConfigMap properties)` Initializes Log with id and properties.
`static boolean`	`isDebug()` Indicates whether a debug level log event will be processed by a log target.
`static boolean`	`isError()` Indicates whether an error level log event will be processed by a log target.
`static boolean`	`isExcludedProperty(String property)` Indicates whether a log property should be excluded.
`static boolean`	`isFatal()` Indicates whether a fatal level log event will be processed by a log target.
`static boolean`	`isInfo()` Indicates whether an info level log event will be processed by a log target.
`static boolean`	`isWarn()` Indicates whether a warn level log event will be processed by a log target.
`static short`	`readLevel(String l)`
`static void`	`removeTarget(Target target)` Removes a target from the log.
`static void`	`reset()` This method removes all of the current loggers and targets from the cache.
`static void`	`setPrettyPrinterClass(String value)`

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

- Field Detail
  - INVALID_CHARS
```
public static final String INVALID_CHARS
```
    See Also:
    Constant Field Values
  - VALUE_SUPRESSED
```
public static final String VALUE_SUPRESSED
```
    See Also:
    Constant Field Values
- Method Detail
  - createLog
```
public static Log createLog()
```
    Creates the log on first access, returns already created log on subsequent calls.
    
    Returns:
    log.
  - initialize
```
public static void initialize(String id,
              ConfigMap properties)
```
    Initializes Log with id and properties.
    
    Parameters:
    id - Id for the Log which is ignored, though is used by the ManageableComponent superclass
    properties - ConfigMap of properties for the Log.
  - isFatal
```
public static boolean isFatal()
```
    Indicates whether a fatal level log event will be processed by a log target.
    
    Returns:
    boolean true if it is Fatal level
  - isError
```
public static boolean isError()
```
    Indicates whether an error level log event will be processed by a log target.
    
    Returns:
    boolean true if it is Error level
  - isWarn
```
public static boolean isWarn()
```
    Indicates whether a warn level log event will be processed by a log target.
    
    Returns:
    boolean true if it is Warn level
  - isInfo
```
public static boolean isInfo()
```
    Indicates whether an info level log event will be processed by a log target.
    
    Returns:
    boolean true if it is Info level
  - isDebug
```
public static boolean isDebug()
```
    Indicates whether a debug level log event will be processed by a log target.
    
    Returns:
    boolean true if it is debug level
  - isExcludedProperty
```
public static boolean isExcludedProperty(String property)
```
    Indicates whether a log property should be excluded.
    
    Parameters:
    property - the property to check
    
    Returns:
    boolean true if the property should be excluded
  - getLogger
```
public static Logger getLogger(String category)
```
    Given a category, returns the logger associated with the category.
    
    Parameters:
    category - Categogry for the logger.
    
    Returns:
    Logger associated with the category.
  - getLogger
```
public static Logger getLogger(Log log,
               String category)
```
  - getTargets
```
public static List getTargets()
```
    Returns an unmodifiable snapshot of the targets registered with this Log when the method is invoked.
    
    Returns:
    List the list of targets
  - getTargetMap
```
public static Map getTargetMap()
```
    Return the Log's map of targets keyed on their human-readable ids (e.g. ConsoleTarget0, ConsoleTarget1, etc.)
    
    Returns:
    Map the target map
  - getTarget
```
public static Target getTarget(String searchId)
```
    Returns the target associated with the unique ID searchId. Returns null if no such target exists.
    
    Parameters:
    searchId - the search ID
    
    Returns:
    Target the associated target
  - getLoggers
```
public String[] getLoggers()
```
    Return the categories for all of the loggers
    
    Returns:
    String[] the categories for all of the loggers
  - addTarget
```
public static void addTarget(Target target)
```
    Adds a target to the log.
    
    Parameters:
    target - Target to be added.
  - removeTarget
```
public static void removeTarget(Target target)
```
    Removes a target from the log.
    
    Parameters:
    target - The target to be removed.
  - reset
```
public static void reset()
```
    This method removes all of the current loggers and targets from the cache. and resets target level.
  - flush
```
public static void flush()
```
  - readLevel
```
public static short readLevel(String l)
```
  - hasIllegalCharacters
```
public static boolean hasIllegalCharacters(String value)
```
    Parameters:
    value - to check for illegal characters. The following characters are not valid: []~$^&\/(){}<>+=`!#%?,:;'"@
    
    Returns:
    true if there are any illegal characters found, false otherwise
  - getPrettyPrinter
```
public static PrettyPrinter getPrettyPrinter()
```
  - getTargetLevel
```
public static short getTargetLevel()
```
  - setPrettyPrinterClass
```
public static void setPrettyPrinterClass(String value)
```
    Parameters:
    value - Name of the pretty printer class.
  - checkFilterToCategory
```
public static boolean checkFilterToCategory(String filter,
                            String category)
```
    Check whether the category match with the filter.
    
    Parameters:
    filter - The filter string to check against a specific category
    category - The category which the filter could match
    
    Returns:
    whether the filter matches a specific category
  - clear
```
public static void clear()
```
    Clean up static member variables.

Class Log

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INVALID_CHARS

VALUE_SUPRESSED

Method Detail

createLog

initialize

isFatal

isError

isWarn

isInfo

isDebug

isExcludedProperty

getLogger

getLogger

getTargets

getTargetMap

getTarget

getLoggers

addTarget

removeTarget

reset

flush

readLevel

hasIllegalCharacters

getPrettyPrinter

getTargetLevel

setPrettyPrinterClass

checkFilterToCategory

clear