Module org.jhotdraw8.css

Package org.jhotdraw8.css.converter

Class ListCssConverter<T>

java.lang.Object

org.jhotdraw8.css.converter.ListCssConverter<T>

Type Parameters:

T - the element type

All Implemented Interfaces:

Converter<ImmutableList<T>>, CssConverter<ImmutableList<T>>

public class ListCssConverter<T>
extends Object
implements CssConverter<ImmutableList<T>>

Parses a list with items separated by configurable optional delimiters.

If the delimiter consists of multiple character tokens, then the parser accepts each of the character tokens and any combination of them.

The delimiters are optional when the list is parsed from a String. When the list is converted into a String, then the specified delimiters are used to separate the items.

Stops parsing at EOF, semicolon and closing bracket.

This parser is intentionally forgiving, so that lists can be output with nice delimiters, but the user does not need to type the delimiter.

In CSS list elements are separated by a comma character.

References:

CSS Syntax Module Level 3, 5.3.11. Parse a comma-separated list of component values

w3.org

Constructor Summary

Constructors

Constructor	Description
ListCssConverter(@NonNull CssConverter<T> elementConverter)
ListCssConverter(@NonNull CssConverter<T> elementConverter, @NonNull Iterable<CssToken> delimiter, @NonNull Iterable<CssToken> prefix, @NonNull Iterable<CssToken> suffix)	Creates a new instance that does not sort the elements.
ListCssConverter(@NonNull CssConverter<T> elementConverter, @NonNull Iterable<CssToken> delimiter, @NonNull Iterable<CssToken> prefix, @NonNull Iterable<CssToken> suffix, @Nullable Comparator<T> comparatorForSorting)	Creates a new instance.
ListCssConverter(@NonNull CssConverter<T> elementConverter, @Nullable String delimiter)
ListCssConverter(@NonNull CssConverter<T> elementConverter, @Nullable String delimiter, @Nullable String prefix, @Nullable String suffix)
ListCssConverter(@NonNull CssConverter<T> elementConverter, @Nullable String delimiter, @Nullable String prefix, @Nullable String suffix, @Nullable Comparator<T> comparatorForSorting)

Method Summary

Modifier and Type	Method	Description
@Nullable ImmutableList<T>	getDefaultValue()
@Nullable String	getHelpText()	Gets a help text.
boolean	isNullable()
boolean	needsIdResolver()
ImmutableList<T>	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 ImmutableList<T>> void	produceTokens(@Nullable TT value, @Nullable IdSupplier idSupplier, @NonNull Consumer<CssToken> out)	Produces tokens for the specified 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, toString, toString

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

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

Constructor Details

ListCssConverter

public ListCssConverter(@NonNull CssConverter<T> elementConverter)

ListCssConverter

public ListCssConverter(@NonNull CssConverter<T> elementConverter,
 @Nullable String delimiter)

ListCssConverter

public ListCssConverter(@NonNull CssConverter<T> elementConverter,
 @Nullable String delimiter,
 @Nullable String prefix,
 @Nullable String suffix)

ListCssConverter

public ListCssConverter(@NonNull CssConverter<T> elementConverter,
 @Nullable String delimiter,
 @Nullable String prefix,
 @Nullable String suffix,
 @Nullable Comparator<T> comparatorForSorting)

Parameters:

elementConverter - the convert for a single element

delimiter - a String which must be parsable into character tokens, each token and any combination of them is accepted as an optional delimiter

prefix - the prefix of the list, for example a left bracket

suffix - the suffix of the list, for example a right bracket

comparatorForSorting - if this value is non-null, then it is used to sort the list

ListCssConverter

public ListCssConverter(@NonNull CssConverter<T> elementConverter,
 @NonNull Iterable<CssToken> delimiter,
 @NonNull Iterable<CssToken> prefix,
 @NonNull Iterable<CssToken> suffix)

Creates a new instance that does not sort the elements.

Parameters:

elementConverter - converter for elements

delimiter - optional delimiter for parsing; the delimiter is used for pretty printing

prefix - white-space tokens for pretty printing that are used when producing tokens or a String

suffix - white-space tokens for pretty printing that are used when producing tokens or a String

ListCssConverter

public ListCssConverter(@NonNull CssConverter<T> elementConverter,
 @NonNull Iterable<CssToken> delimiter,
 @NonNull Iterable<CssToken> prefix,
 @NonNull Iterable<CssToken> suffix,
 @Nullable Comparator<T> comparatorForSorting)

Creates a new instance.

Parameters:

elementConverter - converter for elements

delimiter - optional delimiter for parsing; the delimiter is used for pretty printing

prefix - white-space tokens for pretty printing that are used when producing tokens or a String

suffix - white-space tokens for pretty printing that are used when producing tokens or a String

comparatorForSorting - optional comparator for sorting; null means no sorting

Method Details

parse

public ImmutableList<T> 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<T>

Parameters:

tt - tokenizer positioned on the token

idResolver - the id factory

Returns:

the parsed value

Throws:

ParseException - on parse exception

IOException - on io exception

needsIdResolver

public boolean needsIdResolver()

Specified by:

needsIdResolver in interface Converter<T>

produceTokens

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

Description copied from interface: CssConverter

Produces tokens for the specified value.

Specified by:

produceTokens in interface CssConverter<T>

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

getDefaultValue

public @Nullable ImmutableList<T> getDefaultValue()

Specified by:

getDefaultValue in interface Converter<T>

isNullable

public boolean isNullable()

Specified by:

isNullable in interface CssConverter<T>

getHelpText

public @Nullable String getHelpText()

Description copied from interface: CssConverter

Gets a help text.

Specified by:

getHelpText in interface Converter<T>

Specified by:

getHelpText in interface CssConverter<T>

Returns:

a help text.