net.sf.mmm.util.property.api.lang

Class StringListProperty

java.lang.Object

net.sf.mmm.util.property.api.AbstractProperty<V>

net.sf.mmm.util.property.api.AbstractValueProperty<V>

net.sf.mmm.util.property.api.AbstractRegularProperty<String>

net.sf.mmm.util.property.api.lang.StringProperty

net.sf.mmm.util.property.api.lang.StringListProperty

All Implemented Interfaces:

Cloneable, javafx.beans.Observable, javafx.beans.property.Property<String>, javafx.beans.property.ReadOnlyProperty<String>, javafx.beans.value.ObservableObjectValue<String>, javafx.beans.value.ObservableStringValue, javafx.beans.value.ObservableValue<String>, javafx.beans.value.WritableObjectValue<String>, javafx.beans.value.WritableStringValue, javafx.beans.value.WritableValue<String>, JsonSupport, AttributeReadName, AttributeReadValue<String>, AttributeWriteValue<String>, ReadableStringProperty, WritableStringProperty, PropertyPath<String>, ReadableObjectProperty<String>, ReadableProperty<String>, WritableProperty<String>

public class StringListProperty
extends StringProperty

This is an extension of StringProperty that stores a list of String values that are enclosed with pipe-symbols.

Since:

8.0.0

Author:

hohwille

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.mmm.util.property.api.AbstractProperty

AbstractProperty.PropertyBuilder<T extends AbstractProperty<? extends V>>

Field Summary

Fields

Modifier and Type	Field and Description
private static char	DEFAULT_CSV_SEPARATOR
private static String	DEFAULT_CSV_SEPARATOR_STRING
private static char	SEPARATOR
private static String	SEPARATOR_PATTERN

Fields inherited from interface net.sf.mmm.util.property.api.lang.ReadableStringProperty

TYPE

Fields inherited from interface net.sf.mmm.util.json.api.JsonSupport

PROPERTY_TYPE

Fields inherited from interface net.sf.mmm.util.property.api.WritableProperty

NO_PROPERTIES

Constructor Summary

Constructors

Constructor and Description
StringListProperty(String name, Bean bean) The constructor.
StringListProperty(String name, Bean bean, AbstractValidator<? super String> validator) The constructor.
StringListProperty(String name, Bean bean, Supplier<String> expression) The constructor.

Method Summary

Modifier and Type	Method and Description
boolean	add(String element, boolean distinct)
private List<String>	asList()
boolean	contains(String element)
protected boolean	doSetValue(String newValue) Called from AbstractValueProperty.setValue(Object).
String	getValueAsCsv()
String	getValueAsCsv(String separator)
List<String>	getValueAsList()
Set<String>	getValueAsSet()
boolean	remove(String element)
void	setValueAsCollection(Collection<String> list)
void	setValueAsCsv(String csv)
void	setValueAsCsv(String csv, char separator)
void	setValueAsCsv(String csv, char separator, boolean trim)
protected void	toJson(javax.json.stream.JsonGenerator json, String stringValue)
private String	wrap(String value)

Methods inherited from class net.sf.mmm.util.property.api.lang.StringProperty

doGetValue, fromJson, withValdidator

Methods inherited from class net.sf.mmm.util.property.api.AbstractRegularProperty

addListener, addListener, fireValueChangedEvent, removeListener, removeListener

Methods inherited from class net.sf.mmm.util.property.api.AbstractValueProperty

bind, bindBidirectional, clearValidationResult, copy, equals, getReadOnly, getValue, hashCode, invalidated, isBound, isReadOnly, isValid, markInvalid, requireWritable, setValue, unbind, unbindBidirectional, validate

Methods inherited from class net.sf.mmm.util.property.api.AbstractProperty

assignValueFrom, clone, copy, copy, copy, copy, copy, getBean, getJsonUtil, getName, getValidator, isMandatory, toJson, toString, withValdidator

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.sf.mmm.util.property.api.lang.WritableStringProperty

get, getValueSafe, length, set

Methods inherited from interface net.sf.mmm.util.property.api.lang.ReadableStringProperty

concat, getType, greaterThan, greaterThan, greaterThanOrEqualTo, greaterThanOrEqualTo, isEmpty, isEqualTo, isEqualTo, isEqualToIgnoreCase, isEqualToIgnoreCase, isNotEmpty, isNotEqualTo, isNotEqualTo, isNotEqualToIgnoreCase, isNotEqualToIgnoreCase, isNotNull, isNull, lessThan, lessThan, lessThanOrEqualTo, lessThanOrEqualTo

Methods inherited from interface net.sf.mmm.util.property.api.ReadableObjectProperty

isEqualTo, isNotEqualTo

Methods inherited from interface net.sf.mmm.util.property.api.ReadableProperty

getBean, getName

Methods inherited from interface javafx.beans.value.ObservableValue

addListener, getValue, removeListener

Methods inherited from interface javafx.beans.Observable

addListener, removeListener

Methods inherited from interface net.sf.mmm.util.lang.api.attribute.AttributeReadValue

getValue

Methods inherited from interface net.sf.mmm.util.json.api.JsonSupport

toJson

Methods inherited from interface net.sf.mmm.util.property.api.WritableProperty

getReadOnly, getReadOnly, isMandatory, isReadOnly, isValid, validate

Methods inherited from interface javafx.beans.property.Property

bind, bindBidirectional, isBound, unbind, unbindBidirectional

Methods inherited from interface net.sf.mmm.util.lang.api.attribute.AttributeWriteValue

setValue

Methods inherited from interface javafx.beans.value.WritableValue

getValue, setValue

Field Detail

SEPARATOR

private static final char SEPARATOR

See Also:

Constant Field Values

SEPARATOR_PATTERN

private static final String SEPARATOR_PATTERN

See Also:

Constant Field Values

DEFAULT_CSV_SEPARATOR

private static final char DEFAULT_CSV_SEPARATOR

See Also:

Constant Field Values

DEFAULT_CSV_SEPARATOR_STRING

private static final String DEFAULT_CSV_SEPARATOR_STRING

Constructor Detail

StringListProperty

public StringListProperty(String name,
                          Bean bean)

The constructor.

Parameters:

name - - see AbstractProperty.getName().

bean - - see AbstractProperty.getBean().

StringListProperty

public StringListProperty(String name,
                          Bean bean,
                          AbstractValidator<? super String> validator)

The constructor.

Parameters:

name - - see AbstractProperty.getName().

bean - - see AbstractProperty.getBean().

validator - - see AbstractValueProperty.validate().

StringListProperty

public StringListProperty(String name,
                          Bean bean,
                          Supplier<String> expression)

The constructor.

Parameters:

name - - see AbstractProperty.getName().

bean - - see AbstractProperty.getBean().

expression - the Supplier providing the actual value.

Method Detail

doSetValue

protected boolean doSetValue(String newValue)

Description copied from class: AbstractValueProperty

Called from AbstractValueProperty.setValue(Object).

Overrides:

doSetValue in class StringProperty

Parameters:

newValue - the new value to set.

Returns:

true if the value has changed, false otherwise.

wrap

private String wrap(String value)

remove

public boolean remove(String element)

Parameters:

element - the element to remove from the value as list.

Returns:

true if the given element was previously present and is now removed so the value actually has changed, false otherwise (if not present and no change).

See Also:

List.remove(Object)

add

public boolean add(String element,
                   boolean distinct)

Parameters:

element - the element to add to the value as list.

distinct - true if the value should be treated as Set and this method should not change the value if the given element is already present, false otherwise.

Returns:

true if the value has changed, false otherwise (if distinct was true and the given element was already present).

See Also:

List.add(Object)

contains

public boolean contains(String element)

Parameters:

element - the element to check.

Returns:

true if the given element is contained in the value as list.

See Also:

List.contains(Object)

asList

private List<String> asList()

getValueAsList

public List<String> getValueAsList()

Returns:

a List with the tokenized value.

getValueAsSet

public Set<String> getValueAsSet()

Returns:

a Set with the tokenized value.

setValueAsCollection

public void setValueAsCollection(Collection<String> list)

Parameters:

list - the List of elements to set as separated string value.

getValueAsCsv

public String getValueAsCsv()

Returns:

the value with comma as separator.

getValueAsCsv

public String getValueAsCsv(String separator)

Parameters:

separator - the character used as separator.

Returns:

the value with elements separated by the given separator.

setValueAsCsv

public void setValueAsCsv(String csv)

Parameters:

csv - the new value as comma separated value (e.g. "a,b,c").

setValueAsCsv

public void setValueAsCsv(String csv,
                          char separator)

Parameters:

csv - the new value with elements separated by the given separator.

separator - the character used as separator.

setValueAsCsv

public void setValueAsCsv(String csv,
                          char separator,
                          boolean trim)

Parameters:

csv - the new value with elements separated by the given separator.

separator - the character used as separator.

trim - if the elements from the given csv should be trimmed.

toJson

protected void toJson(javax.json.stream.JsonGenerator json,
                      String stringValue)

Overrides:

toJson in class StringProperty

Parameters:

json - the JsonGenerator.

stringValue - the value.

See Also:

AbstractProperty.toJson(JsonGenerator)