java.util.logging

接口
java.lang.Object
  继承者 java.util.logging.Formatter
直接已知子类:
SimpleFormatter, XMLFormatter

public abstract class Formatter
     
extends Object

Formatter 为格式化 LogRecords 提供支持。

一般来说,每个日志记录 Handler 都有关联的 Formatter。Formatter 接受 LogRecord,并将它转换为一个字符串。

有些 Formatter(如 XMLFormatter)需要围绕一组格式化记录来包装头部和尾部字符串。可以使用 getHeader 和 getTail 方法来获得这些字符串。

从以下版本开始:
1.4

构造方法摘要
protected Formatter()
          构造一个新的 Formatter。
 
方法摘要
abstract  String format(LogRecord record)
          格式化给定的日志记录,并返回格式化后的字符串。
 String formatMessage(LogRecord record)
          本地化和格式化来自日志记录的消息字符串。
 String getHead(Handler h)
          返回一组格式化记录的头部字符串。
 String getTail(Handler h)
          返回一组格式化记录的尾部字符串。
 
从类 java.lang.Object 继承的方法
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

构造方法详细信息

Formatter

protected Formatter()
构造一个新的 Formatter。

方法详细信息

format

public abstract String format(LogRecord record)
格式化给定的日志记录,并返回格式化后的字符串。

得到的格式化 String 通常包括 LogRecord 消息字段的本地化和格式化版本。Formatter.formatMessage 这个便捷方法可以(可选)用来本地化和格式化消息字段。

参数:
record - 要格式化的日志记录。
返回:
格式化的日志记录

getHead

public String getHead(Handler h)
返回一组格式化记录的头部字符串。

此基类返回一个空字符串,但是它可以通过子类进行重写。

参数:
h - 目标 handler(可以为 null)
返回:
头部字符串

getTail

public String getTail(Handler h)
返回一组格式化记录的尾部字符串。

此基类返回一个空字符串,但是它可以通过子类进行重写。

参数:
h - 目标 handler(可以为 null)
返回:
尾部字符串

formatMessage

public String formatMessage(LogRecord record)
本地化和格式化来自日志记录的消息字符串。在 Formatter 子类执行格式化时,此方法可以作为一种便捷方法使用。

首先使用记录的 ResourceBundle 将消息字符串本地化为格式字符串。(如果不存在 ResourceBundle,或没有找到消息键,则将该键用作格式字符串。)格式 String 使用 java.text 样式进行格式化。

  • 如果没有参数,则不使用 Formatter。
  • 否则,如果字符串包含 "{0",则使用 java.text.MessageFormat 来格式化字符串。
  • 否则,不执行格式化。

参数:
record - 包含原始消息的日志记录
返回:
已本地化和格式化的消息