|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface FrameworkLog
The FramworkLog interface. A FrameworkLog implementation is provided by the FrameworkAdaptor and used by the Framework to log any error messages and FrameworkEvents of type ERROR. The FrameworkLog may persist the log messages to the filesystem or allow other ways of accessing the log information.
Field Summary | |
---|---|
static java.lang.String |
SERVICE_PERFORMANCE
A service lookup constant (value "performance") indicating an implementation of the logging service that logs performance events. |
Method Summary | |
---|---|
void |
close()
Closes the FrameworkLog. |
java.io.File |
getFile()
Returns the log File if it is set, otherwise null is returned. |
void |
log(FrameworkEvent frameworkEvent)
Logs the information from a FrameworkEvent to the FrameworkLog. |
void |
log(FrameworkLogEntry logEntry)
Logs the FrameworkLogEntry to the FrameworkLog |
void |
setConsoleLog(boolean consoleLog)
Sets the console log option. |
void |
setFile(java.io.File newFile,
boolean append)
Sets the current File used to log messages to a FileWriter using the specified File. |
void |
setWriter(java.io.Writer newWriter,
boolean append)
Sets the current Writer used to log messages to the specified newWriter. |
Field Detail |
---|
static final java.lang.String SERVICE_PERFORMANCE
"true"
in order to
obtain a performance log.
Method Detail |
---|
void log(FrameworkEvent frameworkEvent)
frameworkEvent
- The FrameworkEvent to log.void log(FrameworkLogEntry logEntry)
logEntry
- The entry to log.void setWriter(java.io.Writer newWriter, boolean append)
newWriter
- The Writer to use for logging messages.append
- Indicates whether the content of the current Writer
used for logging messages should be appended to the end of the new
Writer.void setFile(java.io.File newFile, boolean append) throws java.io.IOException
newFile
- The File to create a new FileWriter which will be
used for logging messages.append
- Indicates whether the content of the current Writer
used for logging messages should be appended to the end of the new
File.
java.io.IOException
- if any problem occurs while constructing a
FileWriter from the newFile. If this exception is thrown the
FrameworkLog will not be effected and will continue to use the
current Writer to log messages.java.io.File getFile()
void setConsoleLog(boolean consoleLog)
consoleLog
- indicates whether to log to System.outvoid close()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |