Класс Формат

public abstract class Format
extends Object
implements Serializable, Cloneable

Format — это абстрактный базовый класс для форматирования информации, чувствительной к локали, такой как даты, сообщения и числа.

Format определяет программный интерфейс для форматирования чувствительных к локали объектов в String (метод format) и для разбора String обратно в объекты (метод parseObject).

В общем случае, метод parseObject формата должен быть способен разобрать любую строку, отформатированную его методом format. Однако могут быть исключительные случаи, когда это невозможно. Например, метод format может создать два смежных целых числа без разделителя между ними, и в этом случае метод parseObject не сможет определить, какие цифры относятся к какому числу.

Наследование

Java Platform предоставляет три специализированных подкласса Format — DateFormat, MessageFormat, и NumberFormat — для форматирования дат, сообщений и чисел соответственно.

Конкретные подклассы должны реализовать три метода:

1. format(Object obj, StringBuffer toAppendTo, FieldPosition pos)
2. formatToCharacterIterator(Object obj)
3. parseObject(String source, ParsePosition pos)

Эти общие методы позволяют полиморфный разбор и форматирование объектов и используются, например, MessageFormat. Подклассы часто также предоставляют дополнительные методы format для конкретных типов ввода и методы parse для конкретных типов результатов. Любой метод parse, который не принимает аргумент ParsePosition, должен вызывать ParseException, если в начале входного текста нет текста в требуемом формате.

Большинство подклассов также будут реализовывать следующие фабричные методы:

1. getInstance для получения полезного объекта формата, соответствующего текущей локали
2. getInstance(Locale) для получения полезного объекта формата, соответствующего заданной локали

Кроме того, некоторые подклассы могут также реализовывать другие методы getXxxxInstance для более специализированного управления. Например, класс NumberFormat предоставляет методы getPercentInstance и getCurrencyInstance для получения специализированных форматировщиков чисел.

Подклассы Format, которые позволяют программистам создавать объекты для локалей (например, с помощью getInstance(Locale)), также должны реализовать следующий статический метод класса:

public static Locale[] getAvailableLocales()

И, наконец, подклассы могут определить набор констант для идентификации различных полей в отформатированном выводе. Эти константы используются для создания объекта FieldPosition, который идентифицирует информацию, содержащуюся в поле, и его позицию в отформатированном результате. Эти константы должны называться item_FIELD, где item идентифицирует поле. Примеры этих констант см. в классе ERA_FIELD и его друзьях в DateFormat.

Синхронизация

Форматы, как правило, не синхронизированы. Рекомендуется создавать отдельные экземпляры формата для каждого потока. Если несколько потоков одновременно обращаются к формату, он должен быть синхронизирован внешним образом.

Подробное описание конструкторов

Format

protected Format()

Единственный конструктор. (Для вызова конструкторами подклассов, обычно неявным).

Подробное описание методов

format

public final String format(Object obj)

Форматирует объект для получения строки. Это эквивалентно

format(obj, new StringBuffer(), new FieldPosition(0)).toString();

.

Параметры:

obj - Объект для форматирования

Возвращает:

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

Исключения:

IllegalArgumentException - если Format не может отформатировать данный объект

format

public abstract StringBuffer format(Object obj,
                                    StringBuffer toAppendTo,
                                    FieldPosition pos)

Форматирует объект и добавляет результирующий текст в заданный буфер строк. Если аргумент pos идентифицирует поле, используемое форматом, то его индексы устанавливаются в начало и конец первого такого поля.

Параметры:

obj - Объект для форматирования

toAppendTo - место, куда должен быть добавлен текст

pos - FieldPosition идентифицирующий поле в отформатированном тексте

Возвращает:

буфер строк, переданный как toAppendTo, с добавленным отформатированным текстом

Исключения:

NullPointerException - если toAppendTo или pos равно null

IllegalArgumentException - если Format не может отформатировать данный объект

formatToCharacterIterator

public AttributedCharacterIterator formatToCharacterIterator(Object obj)

Параметры:

obj - Объект для форматирования

Возвращает:

AttributedCharacterIterator, описывающий отформатированное значение.

Исключения:

NullPointerException - если obj равен null.

IllegalArgumentException - когда Format не может отформатировать данный объект.

С тех пор:

1.4

parseObject

public abstract Object parseObject(String source,
                                   ParsePosition pos)

Параметры:

source - Строка, часть которой должна быть разобрана.

pos - Объект ParsePosition с информацией об индексе и индексе ошибки, как описано выше.

Возвращает:

Объект, разобранный из строки. В случае ошибки возвращает null.

Исключения:

NullPointerException - если pos равен null.

parseObject

public Object parseObject(String source)
                   throws ParseException

Разбирает текст с начала заданной строки для получения объекта. Метод может не использовать весь текст заданной строки.

Параметры:

source - Строка, начало которой должно быть разобрано.

Возвращает:

Объект, разобранный из строки.

Исключения:

ParseException - если начало заданной строки не может быть разобрано.

clone

public Object clone()

Создает и возвращает копию этого объекта.

Переопределяет:

clone в классе Object

Возвращает:

клонированный экземпляр.

См. также:

Cloneable