/*
* Copyright 2000-2016 Vaadin Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.vaadin.ui;
import com.vaadin.server.SerializableFunction;
/**
* {@link ItemCaptionGenerator} can be used to customize the string shown to the
* user for an item.
*
* @see ComboBox#setItemCaptionGenerator(ItemCaptionGenerator)
* @param <T>
* item type
* @since 8.0
* @author Vaadin Ltd
*/
@FunctionalInterface
public interface ItemCaptionGenerator<T>
extends SerializableFunction<T, String> {
/**
* Gets a caption for the {@code item}.
*
* @param item
* the item to get caption for
* @return the caption of the item; {@code null} will be shown as an empty
* string
*/
@Override
String apply(T item);
}