Module org.jhotdraw8.css

Package org.jhotdraw8.css.converter

Interface CssConverter<T>

Type Parameters:

T - the type of the data that can be converted from/to CSS

All Superinterfaces:

Converter<T>

All Known Implementing Classes:

AbstractCssConverter, BooleanCssConverter, DoubleCssConverter, IntegerCssConverter, KebabCaseEnumCssConverter, ListCssConverter, LiteralEnumCssConverter, LongCssConverter, MappedCssConverter, NumberCssConverter, PercentageCssConverter, PseudoClassCssConverter, SetCssConverter, SizeCssConverter, StringCssConverter, UriCssConverter

public interface CssConverter<T>
extends Converter<T>

Converts a data value of type T from or to a CSS Tokenizer.

Author:

Werner Randelshofer

Method Summary

Modifier and Type	Method	Description
default T	fromString(@NonNull CharSequence buf, @Nullable IdResolver idResolver)
default T	fromString(@NonNull CharBuffer buf, @Nullable IdResolver idResolver)
default @NonNull ImmutableList<String>	getExamples()
@Nullable String	getHelpText()	Gets a help text.
boolean	isNullable()
@Nullable T	parse(@NonNull CssTokenizer tt, @Nullable IdResolver idResolver)	Parses from the given tokenizer and moves the tokenizer to the next token past the value.
default @NonNull T	parseNonNull(@NonNull CssTokenizer tt, @Nullable IdResolver idResolver)	Parses from the given tokenizer and moves the tokenizer to the next token past the value.
<TT extends T> void	produceTokens(@Nullable TT value, @Nullable IdSupplier idSupplier, @NonNull Consumer<CssToken> out)	Produces tokens for the specified value.
default <TT extends T> @NonNull String	toString(@Nullable TT value)	Converts the value to String.
default <TT extends T> @NonNull String	toString(@Nullable TT value, @Nullable IdFactory idFactory)	Converts the value to String.
default <TT extends T> void	toString(@NonNull Appendable out, @Nullable IdSupplier idSupplier, TT value)
default <TT extends T> @NonNull List<CssToken>	toTokens(@Nullable TT value, @Nullable IdSupplier idSupplier)

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

fromString, fromString, getDefaultValue, needsIdResolver, toString, toString

Method Details

parse

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

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

Parameters:

tt - tokenizer positioned on the token

idResolver - the id factory

Returns:

the parsed value

Throws:

ParseException - on parse exception

IOException - on io exception

parseNonNull

default @NonNull T parseNonNull(@NonNull CssTokenizer tt,
 @Nullable IdResolver idResolver)
                         throws ParseException,
IOException

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

Parameters:

tt - tokenizer positioned on the token

idResolver - the id factory

Returns:

the parsed value

Throws:

ParseException - on parse exception

IOException - on io exception

produceTokens

<TT extends T> void produceTokens(@Nullable TT value,
 @Nullable IdSupplier idSupplier,
 @NonNull Consumer<CssToken> out)
                           throws IOException

Produces tokens for the specified value.

Type Parameters:

TT - the value type

Parameters:

value - the value

idSupplier - the id factory

out - the consumer for the tokens

Throws:

IOException - on IO exception

toTokens

default <TT extends T> @NonNull List<CssToken> toTokens(@Nullable TT value,
 @Nullable IdSupplier idSupplier)
                                                 throws IOException

Throws:

IOException

toString

default <TT extends T> @NonNull String toString(@Nullable TT value)

Converts the value to String.

Specified by:

toString in interface Converter<T>

Type Parameters:

TT - the value type

Parameters:

value - the value

Returns:

a String

toString

default <TT extends T> @NonNull String toString(@Nullable TT value,
 @Nullable IdFactory idFactory)

Converts the value to String.

Type Parameters:

TT - the value type

Parameters:

value - the value

idFactory - the id factory

Returns:

a String

toString

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

Specified by:

toString in interface Converter<T>

Throws:

IOException

fromString

default T fromString(@NonNull CharSequence buf,
 @Nullable IdResolver idResolver)
              throws ParseException

Specified by:

fromString in interface Converter<T>

Throws:

ParseException

fromString

default T fromString(@NonNull CharBuffer buf,
 @Nullable IdResolver idResolver)
              throws ParseException

Specified by:

fromString in interface Converter<T>

Throws:

ParseException

getHelpText

@Nullable String getHelpText()

Gets a help text.

Specified by:

getHelpText in interface Converter<T>

Returns:

a help text.

getExamples

default @NonNull ImmutableList<String> getExamples()

isNullable

boolean isNullable()