refine (?) javadoc

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/lang/trunk@631405 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Matthew Jason Benson 2008-02-26 22:24:34 +00:00
parent 20d5b0101b
commit b3883c4dc3
1 changed files with 6 additions and 11 deletions

View File

@ -34,29 +34,24 @@ import org.apache.commons.lang.Validate;
* 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 <code>java.text.MessageFormat</code> can be overridden
* at the format and/or format style level (@see MessageFormat). A "format element"
* at the format and/or format style level (see MessageFormat). A "format element"
* embedded in the message pattern is specified (<b>()?</b> signifies optionality):<br />
* <pre>
* <code>{</code
* <i>argument-number</i>
* <b>(</b>
* <code>,</code><i>format-name</i>
* <b>(</b><code>,</code><i>format-style</i><b>)?</b>
* <b>)?</b>
* <code>}</code>
* </pre>
* <code>{</code<i>argument-number</i><b>(</b><code>,</code><i>format-name</i><b>(</b><code>,</code><i>format-style</i><b>)?</b><b>)?</b><code>}</code>
*
* <p>
* <i>format-name</i> and <i>format-style</i> values are trimmed of surrounding whitespace
* in the manner of <code>java.text.MessageFormat</code>. If <i>format-name</i> denotes
* <code>FormatFactory formatFactoryInstance</code> in <code>registry</code>, a <code>Format</code>
* matching <i>format-name</i> and <i>format-style</i> is requested from
* <code>formatFactoryInstance</code>. If this is successful, the <code>Format</code>
* found is used for this format element.
* </p>
*
* <p>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
* <code>UnsupportedOperationException</code>s if called.</p>
* <code>UnsupportedOperationException</code> if called.
* </p>
*
* @author Matt Benson
* @author Niall Pemberton