AbstractNlsFormatterManager (JavaDocs for mmm-util-nls 8.7.0)

java.lang.Object
- net.sf.mmm.util.component.base.AbstractComponent
- - net.sf.mmm.util.nls.base.AbstractNlsFormatterManager

All Implemented Interfaces:

NlsArgumentParser, NlsFormatterManager

Direct Known Subclasses:

MappedNlsFormatterManager
```
public abstract class AbstractNlsFormatterManager
extends AbstractComponent
implements NlsFormatterManager, NlsArgumentParser
```
This is the abstract base implementation of the NlsFormatterManager interface.
You should extend this class rather than directly implementing the NlsFormatterManager interface to gain compatibility with further releases.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields
Modifier and Type	Field and Description
`private static AbstractNlsFormatterManager`	`instance`
`private JustificationBuilder`	`justificationBuilder`
`private static org.slf4j.Logger`	`LOG`
`protected static CharFilter`	`NO_COMMA_OR_END_EXPRESSION` A char filter that accepts everything except ',' and '}'.
`protected static CharFilter`	`NO_EXPRESSION` A char filter that accepts everything except ',' and '}'.

Fields inherited from interface net.sf.mmm.util.nls.api.NlsFormatterManager
STYLE_CURRENCY, STYLE_FULL, STYLE_INTEGER, STYLE_ISO_8601, STYLE_LONG, STYLE_MEDIUM, STYLE_PERCENT, STYLE_SHORT, TYPE_CHOICE, TYPE_DATE, TYPE_DATETIME, TYPE_NUMBER, TYPE_TIME, TYPE_TYPE

Fields inherited from interface net.sf.mmm.util.nls.api.NlsArgumentParser
END_EXPRESSION, FORMAT_SEPARATOR, START_EXPRESSION

Constructor Summary

Constructors
Constructor and Description

AbstractNlsFormatterManager()
The constructor.

Constructors
Constructor and Description
`AbstractNlsFormatterManager()` The constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`doInitialize()`
`protected void`	`doInitialized()`
`NlsFormatterPlugin<Object>`	`getFormatter()` This method gets the default `NlsFormatter`.
`NlsFormatterPlugin<?>`	`getFormatter(String formatType)` This method gets the `NlsFormatter` for the given `formatType`.
`static AbstractNlsFormatterManager`	`getInstance()` This method gets the singleton instance of this `AbstractNlsFormatterManager`.
`protected JustificationBuilder`	`getJustificationBuilder()` This method gets the `JustificationBuilder` used to `build` `Justification`s.
`protected NlsFormatterPlugin<?>`	`getSubFormatter(String formatType, CharSequenceScanner scanner)` This method is like `NlsFormatterManager.getFormatter(String, String)` but reads the `style` from the given scanner.
`NlsArgument`	`parse(CharSequenceScanner scanner)` This method parses the `internationalized message` given as `CharSequenceScanner` pointing the beginning of an argument (immediately after `NlsArgumentParser.START_EXPRESSION`).
`void`	`setJustificationBuilder(JustificationBuilder justificationBuilder)`

Methods inherited from class net.sf.mmm.util.component.base.AbstractComponent
getInitializationState, initialize

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.sf.mmm.util.nls.api.NlsFormatterManager
getFormatter

- Field Detail
  - LOG
```
private static final org.slf4j.Logger LOG
```
  - NO_COMMA_OR_END_EXPRESSION
```
protected static final CharFilter NO_COMMA_OR_END_EXPRESSION
```
    A char filter that accepts everything except ',' and '}'.
  - NO_EXPRESSION
```
protected static final CharFilter NO_EXPRESSION
```
    A char filter that accepts everything except ',' and '}'.
  - instance
```
private static AbstractNlsFormatterManager instance
```
  - justificationBuilder
```
private JustificationBuilder justificationBuilder
```
- Constructor Detail
  - AbstractNlsFormatterManager
```
public AbstractNlsFormatterManager()
```
    The constructor.
- Method Detail
  - getInstance
```
public static AbstractNlsFormatterManager getInstance()
```
    This method gets the singleton instance of this AbstractNlsFormatterManager.
    ATTENTION:
    Please prefer dependency-injection instead of using this method.
    
    Returns:
    
    the singleton instance.
  - doInitialized
```
protected void doInitialized()
```
    Overrides:
    
    doInitialized in class AbstractComponent
  - parse
```
public NlsArgument parse(CharSequenceScanner scanner)
```
    Description copied from interface: NlsArgumentParser
    
    This method parses the internationalized message given as CharSequenceScanner pointing the beginning of an argument (immediately after NlsArgumentParser.START_EXPRESSION).
    
    Specified by:
    
    parse in interface NlsArgumentParser
    
    Parameters:
    
    scanner - is the CharSequenceScanner.
    
    Returns:
    
    the according NlsFormatter instance.
    
    See Also:
    
    NlsFormatterManager.getFormatter(String, String)
  - getSubFormatter
```
protected NlsFormatterPlugin<?> getSubFormatter(String formatType,
                                                CharSequenceScanner scanner)
```
    This method is like NlsFormatterManager.getFormatter(String, String) but reads the style from the given scanner.
    
    Parameters:
    
    formatType - is the type to be formatted.
    
    scanner - is the current CharSequenceScanner for parsing the style defining details of formatting.
    
    Returns:
    
    the according NlsFormatter.
  - doInitialize
```
protected void doInitialize()
```
    Overrides:
    
    doInitialize in class AbstractComponent
  - getJustificationBuilder
```
protected JustificationBuilder getJustificationBuilder()
```
    This method gets the JustificationBuilder used to build Justifications.
    
    Returns:
    
    the JustificationBuilder.
  - setJustificationBuilder
```
@Inject
public void setJustificationBuilder(JustificationBuilder justificationBuilder)
```
    Parameters:
    
    justificationBuilder - is the justificationBuilder to set
  - getFormatter
```
public NlsFormatterPlugin<Object> getFormatter()
```
    Description copied from interface: NlsFormatterManager
    
    This method gets the default NlsFormatter.
    
    Specified by:
    
    getFormatter in interface NlsFormatterManager
    
    Returns:
    
    the default NlsFormatter instance.
    
    See Also:
    
    NlsFormatterManager.getFormatter(String, String)
  - getFormatter
```
public NlsFormatterPlugin<?> getFormatter(String formatType)
```
    Description copied from interface: NlsFormatterManager
    
    This method gets the NlsFormatter for the given formatType.
    
    Specified by:
    
    getFormatter in interface NlsFormatterManager
    
    Parameters:
    
    formatType - is the type to be formatted.
    
    Returns:
    
    the according NlsFormatter instance.
    
    See Also:
    
    NlsFormatterManager.getFormatter(String, String)

Class AbstractNlsFormatterManager

Field Summary

Fields inherited from interface net.sf.mmm.util.nls.api.NlsFormatterManager

Fields inherited from interface net.sf.mmm.util.nls.api.NlsArgumentParser

Constructor Summary

Method Summary

Methods inherited from class net.sf.mmm.util.component.base.AbstractComponent

Methods inherited from class java.lang.Object

Methods inherited from interface net.sf.mmm.util.nls.api.NlsFormatterManager

Field Detail

LOG

NO_COMMA_OR_END_EXPRESSION

NO_EXPRESSION

instance

justificationBuilder

Constructor Detail

AbstractNlsFormatterManager

Method Detail

getInstance

doInitialized

parse

getSubFormatter

doInitialize

getJustificationBuilder

setJustificationBuilder

getFormatter

getFormatter