Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.commons.lang.text
Class ExtendedMessageFormat

    java.lang.Object
      java.text.Format
          java.text.MessageFormat
              org.apache.commons.lang.text.ExtendedMessageFormat

All Implemented Interfaces:
  java.lang.Cloneable, java.io.Serializable

public class ExtendedMessageFormat
extends java.text.MessageFormat

Extends `java.text.MessageFormat` to allow pluggable/additional formatting options for embedded format elements. Client code should specify a registry of `FormatFactory` instances associated with `String` format names. This registry will be consulted when the format elements are parsed from the message pattern. In this way custom patterns can be specified, and the formats supported by `java.text.MessageFormat` can be overridden at the format and/or format style level (see MessageFormat). A "format element" embedded in the message pattern is specified (()? signifies optionality):
`{`argument-number(`,`format-name(`,`format-style)?)?`}`

format-name and format-style values are trimmed of surrounding whitespace in the manner of `java.text.MessageFormat`. If format-name denotes `FormatFactory formatFactoryInstance` in `registry`, a `Format` matching format-name and format-style is requested from `formatFactoryInstance`. If this is successful, the `Format` found is used for this format element.

NOTICE: The various subformat mutator methods are considered unnecessary; they exist on the parent class to allow the type of customization which it is the job of this class to provide in a configurable fashion. These methods have thus been disabled and will throw `UnsupportedOperationException` if called.

Limitations inherited from `java.text.MessageFormat`:

- When using "choice" subformats, support for nested formatting instructions is limited to that provided by the base class.
- Thread-safety of `Format`s, including `MessageFormat` and thus `ExtendedMessageFormat`, is not guaranteed.

Since:
  2.4
Version:
  $Id: ExtendedMessageFormat.java 635447 2008-03-10 06:27:09Z bayard $
Author:
  Matt Benson, Niall Pemberton
See Also:
  Serialized Form

Nested Class Summary

Nested classes inherited from class java.text.MessageFormat
`java.text.MessageFormat.Field`

Constructor Summary
`ExtendedMessageFormat(java.lang.String pattern)` Create a new ExtendedMessageFormat for the default locale.
`ExtendedMessageFormat(java.lang.String pattern, java.util.Locale locale)` Create a new ExtendedMessageFormat.
`ExtendedMessageFormat(java.lang.String pattern, java.util.Locale locale, java.util.Map registry)` Create a new ExtendedMessageFormat.
`ExtendedMessageFormat(java.lang.String pattern, java.util.Map registry)` Create a new ExtendedMessageFormat for the default locale.

Method Summary
`void` | `applyPattern(java.lang.String pattern)` Apply the specified pattern.
`void` | `setFormat(int formatElementIndex, java.text.Format newFormat)`
`void` | `setFormatByArgumentIndex(int argumentIndex, java.text.Format newFormat)`
`void` | `setFormats(java.text.Format[] newFormats)`
`void` | `setFormatsByArgumentIndex(java.text.Format[] newFormats)`
`java.lang.String` | `toPattern()`

Methods inherited from class java.text.MessageFormat
`clone, equals, format, format, format, formatToCharacterIterator, getFormats, getFormatsByArgumentIndex, getLocale, hashCode, parse, parse, parseObject, setLocale`

Methods inherited from class java.text.Format
`format, parseObject`

Methods inherited from class java.lang.Object
`finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### ExtendedMessageFormat

    public ExtendedMessageFormat(java.lang.String pattern)

  Create a new ExtendedMessageFormat for the default locale.

Parameters:
  `pattern` - String
Throws:
  `java.lang.IllegalArgumentException` - in case of a bad pattern.

### ExtendedMessageFormat

    public ExtendedMessageFormat(java.lang.String pattern,
                                 java.util.Locale locale)

  Create a new ExtendedMessageFormat.

Parameters:
  `pattern` - String
  `locale` - Locale
Throws:
  `java.lang.IllegalArgumentException` - in case of a bad pattern.

### ExtendedMessageFormat

    public ExtendedMessageFormat(java.lang.String pattern,
                                 java.util.Map registry)

  Create a new ExtendedMessageFormat for the default locale.

Parameters:
  `pattern` - String
  `registry` - Registry of format factories: Map
Throws:
  `java.lang.IllegalArgumentException` - in case of a bad pattern.

### ExtendedMessageFormat

    public ExtendedMessageFormat(java.lang.String pattern,
                                 java.util.Locale locale,
                                 java.util.Map registry)

  Create a new ExtendedMessageFormat.

Parameters:
  `pattern` - String
  `locale` - Locale
  `registry` - Registry of format factories: Map
Throws:
  `java.lang.IllegalArgumentException` - in case of a bad pattern.

Method Detail

### toPattern

    public java.lang.String toPattern()

### applyPattern

    public final void applyPattern(java.lang.String pattern)

  Apply the specified pattern.

  Parameters:
    `pattern` - String

### setFormat

    public void setFormat(int formatElementIndex,
                          java.text.Format newFormat)

  Throws:
    `java.lang.UnsupportedOperationException`

### setFormatByArgumentIndex

    public void setFormatByArgumentIndex(int argumentIndex,
                                         java.text.Format newFormat)

  Throws:
    `java.lang.UnsupportedOperationException`

### setFormats

    public void setFormats(java.text.Format[] newFormats)

  Throws:
    `java.lang.UnsupportedOperationException`

### setFormatsByArgumentIndex

    public void setFormatsByArgumentIndex(java.text.Format[] newFormats)

  Throws:
    `java.lang.UnsupportedOperationException`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2001-2008 The Apache Software Foundation. All Rights Reserved.