Методы класса Formatter

В классе Formatter определены методы, перечисленные в табл. 9.1

Метод	Описание
void close() void flush()	Закрывает вызывающий объект класса Formatter, Это приводит к освобождению ресурсов, используемых объектом, После закрытия объекта типа Formatter, он не может повторно использоваться. Попытка использовать закрытый объект приводит к генерации исключения типа FormatterClosedException Переносит информацию из буфера форматирования. Это вызывает запись в указанное место выходных данных, находящихся в буфере. Чаще всего используется объектом класса Formatter, связанным с файлом
Formatter format(String fmtString, Object...args)	Форматирует аргументы, переданные в аргументе переменной длины (vararg) args, в соответствии со спецификаторами формата, содержащимися в fmtString. Возвращает вызывающий объект
Formatter format(Locale loc, String fmtString, Object...args)	Форматирует аргументы, переданные в аргументе переменной длины args, в соответствии со спецификаторами формата, содержащимися в fmtString. При форматировании используются региональные установки, заданные в lос. Возвращает вызывающий объект
IOException ioException()	Если объект, приемник отформатированного вывода, генерирует исключение типа lOException, возвращает это исключение. 8 противном случае возвращает null
Locale locale()	Возвращает региональные установки вызывающего объекта
Appendable out()	Возвращает ссылку на базовый объект-приемник для выходных данных
String toString()	Возвращает объект типа String, содержащий отформатированный вывод

Основы форматирования

После создания объекта класса Formatter Вы можете его применить для формирования форматированной строки. Для этого используйте метод format (). В следующей строке приведена самая общеупотребительная его версия

Formatter format(String fmtString, Object...args)

Параметр fmtString состоит из элементов двух типов. Первый тип формируется из символов, которые просто копируются в буфер вывода. Второй тип содержит спецификаторы формата (format specifiers), определяющие способ отображения последующих аргументов.

Простейший спецификатор начинается со знака процента, за которым следует преобразующий спецификатор формата (format conversion specifier). Все преобразующие спецификаторы формата состоят из одиночных символов.

Например, спецификатор формата для данных с плавающей точкой — %f. Как правило, спецификаторов формата должно быть столько же, сколько аргументов первого типа, и соответствие спецификаторов формата аргументам первого типа устанавливается в направлении слева направо. Рассмотрим приведенный далее фрагмент:

Formatter fmt = new Formatter ();

fmt.format("Formatting %s is easy %d %£", "with Java", 10, 98.6);

в нем создается объект класса Formatter, содержащий следующую строку:

Formatting with Java is easy 10 98.600000

В данном примере спецификаторы формата: %s, %d и %f, замещаются аргументами, следующими далее в строке форматирования. Таким образом, спецификатор %s заменен строкой "with Java", спецификатор %d — числом 10, а спецификатор %f — числом 98.6. Все остальные символы используются без изменения. Как Вы могли догадаться, спецификатор %s задает строку, а спецификатор %<а — целое число. Как уже упоминалось, спецификатор %f задает значение с плавающей точкой.

Метод format() принимает множество разных спецификаторов формата, перечисленных в табл. 9.2. Обратите внимание на то, что у многих из них есть две формы представления: в верхнем и нижнем регистрах. Когда используется спецификатор, набранный в верхнем регистре, отображаются заглавные буквы. В остальном спецификаторы, набранные в верхнем и нижнем регистрах, выполняют одни те же преобразования, Важно знать, что язык Java контролирует соответствие каждого спецификатора формата типу связанного с ним аргумента. Если это соответствие нарушено, генерируется исключение типа IllegalFormatException.

После форматирования строки Вы можете получить ее, вызвав метод toString(). Если продолжить предыдущий пример, оператор, приведенный в следующей строке, получает отформатированную строку, содержащуюся в объекте fmt:

String str = fmt.toString();

Конечно, если Вы хотите просто вывести на экран отформатированную строку, не нужно ее сначала присваивать объекту типа String. Когда объект класса Formatter передается, например, в метод println(), метод toString() вызывается автоматически.

Таблица 9.2. Спецификаторы формата

Спецификатор формата	Выполняемое преобразование
%a %A	Шестнадцатеричное значение с плавающей точкой
%B %B	Логическое (булево) значение аргумента
%c %C	Символьное представление аргумента
%d	Десятичное целое значение аргумента
%h %H	Хэш-код аргумента
%e %E	Экспоненциальное представление аргумента
%f	Десятичное значение с плавающей точкой
%g %G	Выбирает более короткое представление из двух: %е или %f
%o	Восьмеричное целое значение аргумента
%n	Вставка символа новой строки
%s %S	Строковое представление аргумента
%t %T	Время и дата
%x	Шестнадцатеричное целое значение аргумента
%%	Вставка знака %

В листинге 9.1 приведена короткая программа, в которой собраны все фрагменты, демонстрирующие создание и вывод на экран отформатированной строки.

Листинг 9.1. Простой пример использования класса Formatter

import java.util.*;

class FormatDemo {

public static void main(String args[]) {

Formatter fmt = new Formatter();

fmt.format("Formatting %s is easy %d %f", "with Java", 10, 98.6);

System.out.println(fmt);

}

}

Одно замечание: Вы можете получить ссылку на основной буфер вывода, вызвав метод out (). Он возвращает объект типа Appendabie. Интерфейс Арpendable включен в версию Java 2 5.0.

Теперь Вы познакомились с основным механизмом, применяемым для создания форматированной строки, в оставшейся части этого раздела будет подробно обсуждаться каждый вид преобразования, а также другие параметры форматирования, такие как выравнивание, минимальная ширина поля и точность представления данных.