Module org.jhotdraw8.base

Package org.jhotdraw8.base.converter

Class MappedConverter<E>

java.lang.Object

org.jhotdraw8.base.converter.MappedConverter<E>

Type Parameters:

E - the data type

All Implemented Interfaces:

Converter<E>

public class MappedConverter<E>
extends Object
implements Converter<E>

This converter uses a map to convert a data type from/to String.

Constructor Summary

Constructors

Constructor	Description
MappedConverter(@NonNull Map<String,E> fromStringMap)
MappedConverter(@NonNull Map<String,E> fromStringMap, boolean nullable)
MappedConverter(@NonNull Map<String,E> fromStringMap, String nullValue)

Method Summary

Modifier and Type	Method	Description
@Nullable E	fromString(@NonNull CharBuffer in, @Nullable IdResolver idResolver)	Constructs a value from a string.
@Nullable E	getDefaultValue()	Provides a default value for APIs which always require a value even if conversion from String failed.
<TT extends E> void	toString(@NonNull Appendable out, @Nullable IdSupplier idSupplier, @Nullable TT value)	Converts a value to a string and appends it to the provided Appendable.

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, toString

Constructor Details

MappedConverter

public MappedConverter(@NonNull Map<String,E> fromStringMap)

MappedConverter

public MappedConverter(@NonNull Map<String,E> fromStringMap,
 boolean nullable)

MappedConverter

public MappedConverter(@NonNull Map<String,E> fromStringMap,
 String nullValue)

Method Details

fromString

public @Nullable E fromString(@NonNull CharBuffer in,
 @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<E>

Parameters:

in - 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 E 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<E>

Returns:

The default value to use when conversion from String failed.

toString

public <TT extends E> void toString(@NonNull Appendable out,
 @Nullable IdSupplier idSupplier,
 @Nullable TT value)
                             throws IOException

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<E>

Type Parameters:

TT - the value type

Parameters:

out - The appendable

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

value - The value. Nullable.

Throws:

IOException - thrown by Appendable