io.micronaut.starter.api.SelectOptionDTO Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of micronaut-starter-api Show documentation

Generates Micronaut applications

There is a newer version: 4.7.0

Show newest version

/*
 * Copyright 2017-2022 original authors
 *
 * 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
 *
 * https://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 io.micronaut.starter.api;

import io.micronaut.core.annotation.Creator;
import io.micronaut.core.annotation.Introspected;
import io.swagger.v3.oas.annotations.media.ArraySchema;
import io.swagger.v3.oas.annotations.media.Schema;

import java.util.List;

/**
 * Supported Option
 * @param  The underlying option type
 */
@Introspected
public abstract class SelectOptionDTO> {

    /**
     * The list of options
     */
    List options;

    /**
     * The Default option
     */
    T defaultOption;

    @Creator
    public SelectOptionDTO(List options, T defaultOption) {
        this.options = options;
        this.defaultOption = defaultOption;
    }

    @ArraySchema(schema =
        @Schema(description = "the supported options")
    )
    public List getOptions() {
        return options;
    }

    @Schema(description = "the default value")
    public T getDefaultOption() {
        return defaultOption;
    }
}