Module org.jhotdraw8.base

Package org.jhotdraw8.base.converter

Class ConverterFormatAdapter

java.lang.Object

org.jhotdraw8.base.converter.ConverterFormatAdapter

All Implemented Interfaces:

Converter<Object>

public class ConverterFormatAdapter
extends Object
implements Converter<Object>

Allows to use a java.text.Format with the Converter API.

Author:

Werner Randelshofer

Constructor Summary

Constructors

Constructor	Description
ConverterFormatAdapter(Format format)

Method Summary

Modifier and Type	Method	Description
Object	fromString(String string, IdFactory idFactory, @NonNull ParsePosition pp)
Object	fromString(@NonNull CharBuffer buf, @Nullable IdResolver idResolver)	Constructs a value from a string.
@Nullable Object	getDefaultValue()	Provides a default value for APIs which always require a value even if conversion from String failed.
void	toString(Appendable out, @Nullable IdSupplier idSupplier, Object value)	Converts a value to a string and appends it to the provided Appendable.
@NonNull String	toString(Object value)	Converts a value to a String.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jhotdraw8.base.converter.Converter

fromString, fromString, fromString, getHelpText, needsIdResolver, toString, toString

Constructor Details

ConverterFormatAdapter

public ConverterFormatAdapter(Format format)

Method Details

toString

public @NonNull String toString(Object value)

Description copied from interface: Converter

Converts a value to a String.

This method does not change the state of the converter.

Note: this is a convenience method. Implementing classes rarely need to overwrite this method.

Specified by:

toString in interface Converter<Object>

Parameters:

value - The value. Nullable.

Returns:

The String.

fromString

public Object fromString(String string,
 IdFactory idFactory,
 @NonNull ParsePosition pp)

toString

public void toString(Appendable out,
 @Nullable IdSupplier idSupplier,
 Object value)

Description copied from interface: Converter

Converts a value to a string and appends it to the provided Appendable.

This method does not change the state of the converter.

Specified by:

toString in interface Converter<Object>

Parameters:

out - The appendable

idSupplier - The factory for creating object ids. Nullable for non-resolving converters.

value - The value. Nullable.

fromString

public Object fromString(@NonNull CharBuffer buf,
 @Nullable IdResolver idResolver)
                  throws ParseException

Description copied from interface: Converter

Constructs a value from a string.

The converter should try to create the value greedily, by consuming as many characters as possible for the value.

This method does not change the state of the converter.

Specified by:

fromString in interface Converter<Object>

Parameters:

buf - A char buffer which holds the string. The char buffer must be treated as read only! The position of the char buffer denotes the beginning of the string when this method is invoked. After completion of this method, the position is set after the last consumed character.

idResolver - The factory for looking up object ids. Nullable for non-resolving converters.

Returns:

The value. Nullable.

Throws:

ParseException - if conversion failed. The error offset field is set to the position where parsing failed. The position of the buffer is undefined.

getDefaultValue

public @Nullable Object getDefaultValue()

Description copied from interface: Converter

Provides a default value for APIs which always require a value even if conversion from String failed.

Specified by:

getDefaultValue in interface Converter<Object>

Returns:

The default value to use when conversion from String failed.