This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
java.util.logging
interface LoggingMXBean
-
Most common way to construct:
-
LoggingMXBean logBean = LogManager.getLoggingMXBean();
Based on 13 examples
public interface LoggingMXBean
The management interface for the logging facility.
There is a single global instance of the LoggingMXBean.
This instance is an
MXBean
can be obtained by calling
the {@link LogManager#getLoggingMXBean} method or from the
{@link java.lang.management.ManagementFactory#getPlatformMBeanServer
platform MBeanServer} method.
The {@link javax.management.ObjectName ObjectName} for uniquely
identifying the LoggingMXBean within an MBeanServer is:
{@link LogManager#LOGGING_MXBEAN_NAME
java.util.logging:type=Logging}
Method Summary |
String |
Gets the name of the log level associated with the specified logger.
|
List |
Returns the list of currently registered loggers.
|
String |
Returns the name of the parent for the specified logger.
|
void |
Sets the specified logger to the specified new level.
|
getLoggerLevel
public String getLoggerLevel(String loggerName)
-
Gets the name of the log level associated with the specified logger.
If the specified logger does not exist, null
is returned.
This method first finds the logger of the given name and
then returns the name of the log level by calling:
{@link Logger#getLevel Logger.getLevel()}.{@link Level#getName getName()};
If the Level of the specified logger is null,
which means that this logger's effective level is inherited
from its parent, an empty string will be returned.
- Parameters:
loggerName
- The name of the Logger to be retrieved.
- Returns:
- The name of the log level of the specified logger; or
an empty string if the log level of the specified logger
is null. If the specified logger does not
exist, null is returned.
getLoggerNames
public List getLoggerNames()
-
Returns the list of currently registered loggers. This method
calls {@link LogManager#getLoggerNames} and returns a list
of the logger names.
- Returns:
- A list of String each of which is a
currently registered Logger name.
getParentLoggerName
public String getParentLoggerName(String loggerName)
-
Returns the name of the parent for the specified logger.
If the specified logger does not exist, null is returned.
If the specified logger is the root Logger in the namespace,
the result will be an empty string.
- Parameters:
loggerName
- The name of a Logger.
- Returns:
- the name of the nearest existing parent logger;
an empty string if the specified logger is the root logger.
If the specified logger does not exist, null
is returned.
setLoggerLevel
public void setLoggerLevel(String loggerName,
String levelName)
-
Sets the specified logger to the specified new level.
If the levelName is not null, the level
of the specified logger is set to the parsed Level
matching the levelName.
If the levelName is null, the level
of the specified logger is set to null and
the effective level of the logger is inherited from
its nearest ancestor with a specific (non-null) level value.
- Parameters:
loggerName
- The name of the Logger to be set.
Must be non-null.
levelName
- The name of the level to set the specified logger to,
or null if to set the level to inherit
from its nearest ancestor.
This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
This page displays the
Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
The official Sun™ documentation can be found here at
http://java.sun.com/javase/6/docs/api/.