sample/java.util.logging.LoggingMXBean.txt

   1 *java.util.logging.LoggingMXBean* *LoggingMXBean* The management interface for t
   2
   3 public interface interface LoggingMXBean
   4
   5
   6 |java.util.logging.LoggingMXBean_Description|
   7 |java.util.logging.LoggingMXBean_Fields|
   8 |java.util.logging.LoggingMXBean_Constructors|
   9 |java.util.logging.LoggingMXBean_Methods|
  10
  11 ================================================================================
  12
  13 *java.util.logging.LoggingMXBean_Methods*
  14 |java.util.logging.LoggingMXBean.getLoggerLevel(String)|Gets the name of the lo
  15 |java.util.logging.LoggingMXBean.getLoggerNames()|Returns the list of currently
  16 |java.util.logging.LoggingMXBean.getParentLoggerName(String)|Returns the name o
  17 |java.util.logging.LoggingMXBean.setLoggerLevel(String,String)|Sets the specifi
  18
  19 *java.util.logging.LoggingMXBean_Description*
  20
  21 The management interface for the logging facility.
  22
  23 There is a single global instance of the LoggingMXBean. This instance is an
  24 MXBean can be obtained by calling the (|java.util.logging.LogManager|) method
  25 or from the platform
  26 <tt>MBeanServer</tt>(|java.lang.management.ManagementFactory|) method.
  27
  28 The ObjectName(|javax.management.ObjectName|) for uniquely identifying the
  29 LoggingMXBean within an MBeanServer is:
  30 <tt>java.util.logging:type=Logging</tt>(|java.util.logging.LogManager|)
  31
  32
  33 *java.util.logging.LoggingMXBean.getLoggerLevel(String)*
  34
  35 public |java.lang.String| getLoggerLevel(java.lang.String loggerName)
  36
  37 Gets the name of the log level associated with the specified logger. If the
  38 specified logger does not exist, null is returned. This method first finds the
  39 logger of the given name and then returns the name of the log level by calling:
  40 Logger.getLevel()(|java.util.logging.Logger|) .
  41 getName()(|java.util.logging.Level|) ;
  42
  43
  44
  45 If the Level of the specified logger is null, which means that this logger's
  46 effective level is inherited from its parent, an empty string will be returned.
  47
  48     loggerName - The name of the Logger to be retrieved.
  49
  50     Returns: The name of the log level of the specified logger; or an empty string if the
  51              log level of the specified logger is null. If the specified logger
  52              does not exist, null is returned.
  53 *java.util.logging.LoggingMXBean.getLoggerNames()*
  54
  55 public |java.util.List| getLoggerNames()
  56
  57 Returns the list of currently registered loggers. This method calls
  58 (|java.util.logging.LogManager|) and returns a list of the logger names.
  59
  60
  61     Returns: A list of String each of which is a currently registered Logger name.
  62 *java.util.logging.LoggingMXBean.getParentLoggerName(String)*
  63
  64 public |java.lang.String| getParentLoggerName(java.lang.String loggerName)
  65
  66 Returns the name of the parent for the specified logger. If the specified
  67 logger does not exist, null is returned. If the specified logger is the root
  68 Logger in the namespace, the result will be an empty string.
  69
  70     loggerName - The name of a Logger.
  71
  72     Returns: the name of the nearest existing parent logger; an empty string if the
  73              specified logger is the root logger. If the specified logger does
  74              not exist, null is returned.
  75 *java.util.logging.LoggingMXBean.setLoggerLevel(String,String)*
  76
  77 public void setLoggerLevel(
  78   java.lang.String loggerName,
  79   java.lang.String levelName)
  80
  81 Sets the specified logger to the specified new level. If the levelName is not
  82 null, the level of the specified logger is set to the parsed Level matching the
  83 levelName. If the levelName is null, the level of the specified logger is set
  84 to null and the effective level of the logger is inherited from its nearest
  85 ancestor with a specific (non-null) level value.
  86
  87     loggerName - The name of the Logger to be set. Must be non-null.
  88     levelName - The name of the level to set the specified logger to, or null if to set the
  89        level to inherit from its nearest ancestor.
  90
  91