| java.lang.Object
 java.text.Format
org.geotools.util.logging.LoggedFormat
| LoggedFormat | | public class LoggedFormat extends Format (Code) | | Wraps a
Format object in order to either parse fully a string, or log a warning.
This class provides a
LoggedFormat.parse method which performs the following tasks:
- Checks if the string was fully parsed and log a warning if it was not. This is
different than the default
LoggedFormat.parseObject(String) behavior which check only
if the begining of the string was parsed and ignore any remaining characters.
- Ensures that the parsed object is of some specific class specified at construction time.
- If the string can't be fully parsed or is not of the expected class, logs a warning.
since:
2.4
version:
$Id: LoggedFormat.java 27862 2007-11-12 19:51:19Z desruisseaux $
author:
Martin Desruisseaux |
| Constructor Summary | |
| protected | LoggedFormat(Format format, Class type)
Creates a new format wrapping the specified one. |
| LoggedFormat | | protected LoggedFormat(Format format, Class type)(Code) | | Creates a new format wrapping the specified one.
Parameters:
format - The format to use for parsing and formatting.
Parameters:
type - The expected type of parsed values. |
| format | | public StringBuffer format(Object value, StringBuffer toAppendTo, FieldPosition position)(Code) | | Formats the specified object. This method delegates the work to the
specified at construction time.
Parameters:
value - The object to format.
Parameters:
toAppendTo - The buffer where the text is to be appended.
Parameters:
position - Identifies a field in the formatted text. The string buffer passed in with formatted text appended. |
| formatToCharacterIterator | | public AttributedCharacterIterator formatToCharacterIterator(Object value)(Code) | | Formats the specified object. This method delegates the work to the
specified at construction time.
Parameters:
value - The object to format. The character iterator describing the formatted value. |
| getInstance | | public static LoggedFormat getInstance(Format format, Class type)(Code) | | Creates a new format wrapping the specified one.
Parameters:
format - The format to use for parsing and formatting.
Parameters:
type - The expected type of parsed values. |
| getWarningLocale | | protected Locale getWarningLocale()(Code) | | Returns the locale to use for formatting warnings. The default implementation returns
the
.
|
| logWarning | | protected void logWarning(LogRecord warning)(Code) | | Logs a warning. This method is invoked automatically by the
LoggedFormat.parse parse method
when a text can't be fully parsed. The default implementation logs the warning to the
logger specified by the last call to the
LoggedFormat.setLogger setLogger method. Subclasses
may override this method if they want to change the log record before the logging.
Parameters:
warning - The warning to log. |
| parse | | public Object parse(String text)(Code) | | Parses the specified string. If the string can't be parsed, then this method returns
null . If it can be parsed at least partially and is of the kind specified at
construction time, then it is returned. If the string has not been fully parsed, then
a
is prepared and logged.
Parameters:
text - The text to parse, or null . The parsed object, or null if text was null or can't be parsed. |
| parseObject | | public Object parseObject(String text) throws ParseException(Code) | | Parses text from a string to produce an object. This method delegates the work to the
specified at construction time. This method to not perform
any logging.
Parameters:
text - The text to parse. An object parsed from the string.
throws:
ParseException - if parsing failed. |
| parseObject | | public Object parseObject(String text, ParsePosition position)(Code) | | Parses text from a string to produce an object. This method delegates the work to the
specified at construction time. This method to not perform
any logging.
Parameters:
text - The text to parse.
Parameters:
position - Index and error index information. An object parsed from the string, or null in case of error. |
| setCaller | | public void setCaller(Class caller, String method)(Code) | | Sets the
and
for the warnings
eventually emitted by the
LoggedFormat.parse method.
Parameters:
caller - The class to declare as the warning emitter, or null if none.
Parameters:
method - The method to declare as the warning emitter, or null if none. |
| setLogger | | public void setLogger(String logger)(Code) | | Sets the logger where to send the warnings eventually emitted by the
LoggedFormat.parse method.
Parameters:
logger - The logger where to log warnings, or null if none. |
| toString | | public String toString()(Code) | | Returns a string representation for debugging purpose.
|
|
|