com.vaadin.v7.data.util.converter.StringToCollectionConverter Maven / Gradle / Ivy
Show all versions of vaadin-compatibility-server Show documentation
/*
* Copyright (C) 2000-2024 Vaadin Ltd
*
* This program is available under Vaadin Commercial License and Service Terms.
*
* See for the full
* license.
*/
package com.vaadin.v7.data.util.converter;
import java.io.Serializable;
import java.lang.reflect.Modifier;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashSet;
import java.util.Locale;
/**
* A converter that converts from {@link String} to {@link Collection} of tokens
* and back.
*
* Allows to break a string into tokens using delimiter. Each token can be
* converted to its own model using provided converter.
*
* Default constructor uses ", " as delimiter string and
* {@link String} for token types. Other constructors allow to configure
* delimiter and token types.
*
* @since 7.5.0
*
* @author Vaadin Ltd
*
* @deprecated As of 8.0, a lightweight lambda-based converter can be build with
* {@link com.vaadin.data.Binder
* Binder}{@code .forField(...).withConverter(...)} methods.
*/
@Deprecated
public class StringToCollectionConverter
implements Converter {
private final String delimiter;
private final Converter tokenConverter;
private final Class tokenType;
private final CollectionFactory factory;
/**
* Creates converter with ", " as delimiter and {@link String}
* as token model type in collection.
*/
public StringToCollectionConverter() {
this(", ", null, String.class);
}
/**
* Creates converter with given {@code delimiter} and {@link String} as
* token model type in collection.
*
* @param delimiter
* custom delimiter
*/
public StringToCollectionConverter(String delimiter) {
this(delimiter, null, String.class);
}
/**
* Creates converter with given {@code tokenConverter} for convert tokens
* and expected {@code tokenType}.
*
* If {@code tokenConverter} is null then no conversation is done and
* {@link String} is used as token type in resulting model collection.
*
* @param tokenConverter
* converter for token
* @param tokenType
* expected token model type
*/
public StringToCollectionConverter(Converter tokenConverter,
Class tokenType) {
this(", ", tokenConverter, tokenType);
}
/**
* Creates converter with given {@code tokenConverter} for convert tokens
* and expected {@code tokenType}.
*
* If {@code tokenConverter} is null then no conversation is done and
* {@link String} is used as token type in resulting model collection.
*
* @param tokenConverter
* converter for token
* @param tokenClass
* expected token model type
* @param delimiter
* delimiter in presentation string
*/
public StringToCollectionConverter(String delimiter,
Converter tokenConverter, Class tokenClass) {
this(delimiter, tokenConverter, tokenClass,
new DefaultCollectionFactory());
}
/**
* Creates converter with given {@code tokenConverter} for convert tokens
* and expected {@code tokenType}.
*
* If {@code tokenConverter} is null then no conversation is done and
* {@link String} is used as token type in resulting model collection.
*
* @param tokenConverter
* converter for token
* @param tokenClass
* expected token model type
* @param delimiter
* delimiter in presentation string
* @param factory
* factory to create resulting collection
*/
public StringToCollectionConverter(String delimiter,
Converter tokenConverter, Class tokenClass,
CollectionFactory factory) {
if (delimiter == null || delimiter.isEmpty()) {
throw new IllegalArgumentException(
"Delimiter should be non-empty string");
}
this.delimiter = delimiter;
this.tokenConverter = tokenConverter;
tokenType = tokenClass;
this.factory = factory;
}
@Override
public Class getModelType() {
return Collection.class;
}
@Override
public Class getPresentationType() {
return String.class;
}
@Override
public Collection convertToModel(String value,
Class targetType, Locale locale)
throws Converter.ConversionException {
if (value == null) {
return null;
}
int index = value.indexOf(delimiter);
int previous = 0;
Collection result = factory.createCollection(targetType);
Converter converter = tokenConverter;
while (index != -1) {
collectToken(value.substring(previous, index), result, converter,
locale);
previous = index + delimiter.length();
index = value.indexOf(delimiter, previous);
}
collectToken(value.substring(previous), result, converter, locale);
return result;
}
@Override
public String convertToPresentation(Collection value,
Class targetType, Locale locale)
throws Converter.ConversionException {
if (value == null) {
return null;
}
StringBuilder builder = new StringBuilder();
Converter converter = tokenConverter;
for (Object o : value) {
if (converter == null) {
builder.append(o);
} else {
builder.append(
converter.convertToPresentation(o, targetType, locale));
}
builder.append(delimiter);
}
if (builder.length() != 0) {
return builder.substring(0, builder.length() - delimiter.length());
} else {
return builder.toString();
}
}
private void collectToken(String token, Collection collection,
Converter converter, Locale locale) {
if (converter == null) {
collection.add(token);
} else {
collection.add(converter.convertToModel(token, tokenType, locale));
}
}
/**
* Default collection factory implementation.
*
* @author Vaadin Ltd
*/
@Deprecated
public static class DefaultCollectionFactory implements CollectionFactory {
@Override
public Collection createCollection(
Class type) {
if (type.isAssignableFrom(ArrayList.class)) {
return new ArrayList