oracle.dacf.formatter
Interface FormatManager

All Known Implementing Classes:

DefaultFormatManager

public interface FormatManager

FormatManager interface manages a list of Formatters.

Method Summary

java.lang.Object	addFormatter(java.lang.String formatterPathName) adds a Formatter object to the list of formatter's maintained.
Formatter	getFormatter(java.lang.Class forThisClassType) retrieve a Formatter by class type
Formatter	getFormatter(java.lang.Object key) retrieve a Formatter by specifying a key.
java.util.Locale	getLocale() get Locale currently in use
void	removeAllFormatters() remove all Formatter objects maintained by this manager
void	removeFormatter(java.lang.Object key) remove a Formatter object.
void	replaceFormatter(java.lang.Object thisKey, Formatter withThisFormatter) replace a Formatter.
void	setLocale(java.util.Locale thisLocale) define locale to be used.

Method Detail

setLocale

public void setLocale(java.util.Locale thisLocale)
               throws UnknownLocaleException

define locale to be used. Format manager will propogate the request to all Formatters

Parameters:

thisLocale - locale to be used

Throws:

UnknownLocaleException - if the formatter does'nt support the specified Locale.

getLocale

public java.util.Locale getLocale()

get Locale currently in use

addFormatter

public java.lang.Object addFormatter(java.lang.String formatterPathName)
                              throws java.lang.IllegalArgumentException

adds a Formatter object to the list of formatter's maintained.

Parameters:

formatterPathName - fully qualified path name of the formatter class.

Returns:

Object which serves as a key to identify the formatter added

Throws:

java.lang.IllegalArgumentException - when unable to dynamically load a class identified by 'formatterPathName'.

replaceFormatter

public void replaceFormatter(java.lang.Object thisKey,
                             Formatter withThisFormatter)
                      throws java.lang.IllegalArgumentException

replace a Formatter.

Parameters:

thisKey - value returned by addFormatter

withThisFormatter - new Formatter to use

Throws:

java.lang.IllegalArgumentException

removeFormatter

public void removeFormatter(java.lang.Object key)
                     throws java.lang.IllegalArgumentException

remove a Formatter object.

Parameters:

key - identify which object to remove

Throws:

java.lang.IllegalArgumentException - when unable to find Formatter with this key

removeAllFormatters

public void removeAllFormatters()

remove all Formatter objects maintained by this manager

Returns:

none

getFormatter

public Formatter getFormatter(java.lang.Object key)
                       throws UnknownFormatterException

retrieve a Formatter by specifying a key.

Parameters:

key - key to retrieve the formatter object.

Returns:

Formatter object requested for

Throws:

UnknownFormatterException - when requested Formatter object not found.

getFormatter

public Formatter getFormatter(java.lang.Class forThisClassType)
                       throws UnknownFormatterException

retrieve a Formatter by class type

Parameters:

forThisClassType - retrieve a formatter object to format data of this class type.

Returns:

Formatter object requested for

Throws:

UnknownFormatterException - when requested Formatter object not found.