org.dellroad.stuff.vaadin24.data.EnumDataProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dellroad-stuff-vaadin24 Show documentation

DellRoad Stuff classes related to Vaadin 24

The newest version!


/*
 * Copyright (C) 2022 Archie L. Cobbs. All rights reserved.
 */

package org.dellroad.stuff.vaadin24.data;

import com.vaadin.flow.data.provider.ListDataProvider;

import java.util.EnumSet;

import org.dellroad.stuff.vaadin24.field.FieldBuilderContext;

/**
 * A simple data provider containing {@link Enum} values.
 *
 * 
 * When created by a {@link org.dellroad.stuff.vaadin24.field.FieldBuilder}, instances will
 * automatically infer the {@link Enum} type via {@link FieldBuilderContext#inferDataModelType} and then
 * populate themselves with the corresponding enum values.
 */
@SuppressWarnings("serial")
public class EnumDataProvider> extends ListDataProvider {

    private final Class type;

    /**
     * Auto-build Constructor.
     *
     * 
     * This constructor will infer the {@link Enum} type from the annotated method's return value.
     *
     * @param ctx field builder context
     * @throws NullPointerException if {@code ctx} is null
     */
    @SuppressWarnings("unchecked")
    public EnumDataProvider(FieldBuilderContext ctx) {
        this((Class)ctx.inferDataModelType());
    }

    /**
     * Constructor.
     *
     * @param type enum type
     * @throws IllegalArgumentException if {@code type} is null
     * @throws ClassCastException if {@code type} is not an {@link Enum} type
     */
    public EnumDataProvider(Class type) {
        super(EnumSet.allOf(type));
        this.type = type;
    }

    /**
     * Get the enum type.
     *
     * @return enum type
     */
    public Class getEnumType() {
        return this.type;
    }
}