Module org.jhotdraw8.css

Package org.jhotdraw8.css.converter

Class LiteralEnumCssConverter<E extends Enum<E>>

java.lang.Object

org.jhotdraw8.css.converter.LiteralEnumCssConverter<E>

Type Parameters:

E - the type of the enum that can be converted from/to CSS

All Implemented Interfaces:

Converter<E>, CssConverter<E>

public class LiteralEnumCssConverter<E extends Enum<E>>
extends Object
implements CssConverter<E>

CssLiteralEnumConverter. Uses the names of the Java Enum literals for conversion.

If you need a different mapping use MappedCssConverter or KebabCaseEnumCssConverter.

Author:

Werner Randelshofer

Constructor Summary

Constructors

Constructor	Description
LiteralEnumCssConverter(@NonNull Class<E> enumClass)
LiteralEnumCssConverter(@NonNull Class<E> enumClass, boolean nullable)

Method Summary

Modifier and Type	Method	Description
@Nullable E	getDefaultValue()
@Nullable String	getHelpText()	Gets a help text.
boolean	isNullable()
@Nullable E	parse(@NonNull CssTokenizer tt, @Nullable IdResolver idResolver)	Parses from the given tokenizer and moves the tokenizer to the next token past the value.
<TT extends E> void	produceTokens(@Nullable TT value, @Nullable IdSupplier idSupplier, @NonNull Consumer<CssToken> consumer)	Produces tokens for the specified value.
@NonNull String	toString(@Nullable E value)

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

Methods inherited from interface org.jhotdraw8.css.converter.CssConverter

fromString, fromString, getExamples, parseNonNull, toString, toString, toString, toTokens

Constructor Details

LiteralEnumCssConverter

public LiteralEnumCssConverter(@NonNull Class<E> enumClass)

LiteralEnumCssConverter

public LiteralEnumCssConverter(@NonNull Class<E> enumClass,
 boolean nullable)

Method Details

parse

public @Nullable E parse(@NonNull CssTokenizer tt,
 @Nullable IdResolver idResolver)
                  throws ParseException,
IOException

Description copied from interface: CssConverter

Parses from the given tokenizer and moves the tokenizer to the next token past the value.

Specified by:

parse in interface CssConverter<E extends Enum<E>>

Parameters:

tt - tokenizer positioned on the token

idResolver - the id factory

Returns:

the parsed value

Throws:

ParseException - on parse exception

IOException - on io exception

getHelpText

public @Nullable String getHelpText()

Description copied from interface: CssConverter

Gets a help text.

Specified by:

getHelpText in interface Converter<E extends Enum<E>>

Specified by:

getHelpText in interface CssConverter<E extends Enum<E>>

Returns:

a help text.

produceTokens

public <TT extends E> void produceTokens(@Nullable TT value,
 @Nullable IdSupplier idSupplier,
 @NonNull Consumer<CssToken> consumer)

Description copied from interface: CssConverter

Produces tokens for the specified value.

Specified by:

produceTokens in interface CssConverter<E extends Enum<E>>

Type Parameters:

TT - the value type

Parameters:

value - the value

idSupplier - the id factory

consumer - the consumer for the tokens

toString

public @NonNull String toString(@Nullable E value)

getDefaultValue

public @Nullable E getDefaultValue()

Specified by:

getDefaultValue in interface Converter<E extends Enum<E>>

isNullable

public boolean isNullable()

Specified by:

isNullable in interface CssConverter<E extends Enum<E>>