io.micronaut.openapi.visitor.Endpoint Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2017-2023 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.openapi.visitor;

import io.micronaut.inject.ast.ClassElement;
import io.swagger.v3.oas.models.security.SecurityRequirement;
import io.swagger.v3.oas.models.servers.Server;
import io.swagger.v3.oas.models.tags.Tag;

import java.util.Collections;
import java.util.List;

/**
 * Endpoint definition.
 *
 * @author croudet
 */
class Endpoint {

    private ClassElement element;
    private List tags = Collections.emptyList();
    private List servers = Collections.emptyList();
    private List securityRequirements = Collections.emptyList();

    /**
     * Sets the ClassElement of the endpoint.
     *
     * @param element A ClassElement,
     */
    void setClassElement(ClassElement element) {
        this.element = element;
    }

    /**
     * Sets the tags to add to the Endpoint entry in the spec file.
     *
     * @param tags A list of tags.
     */
    void setTags(List tags) {
        this.tags = tags;
    }

    /**
     * Returns the Endpoint ClassElement.
     *
     * @return A ClassElement.
     */
    ClassElement getClassElement() {
        return element;
    }

    /**
     * Returns the tags to add to the Endpoint entry in the spec file.
     *
     * @return The tags to add to the Endpoint entry in the spec file.
     */
    List getTags() {
        return tags;
    }

    /**
     * Returns the servers to add to the Endpoint entry in the spec file.
     *
     * @return The servers to add to the Endpoint entry in the spec file.
     */
    public List getServers() {
        return servers;
    }

    /**
     * Sets the servers to add to the Endpoint entry in the spec file.
     *
     * @param servers A list of servers.
     */
    public void setServers(List servers) {
        this.servers = servers;
    }

    /**
     * Returns the securityRequirements to add to the Endpoint entry in the spec file.
     *
     * @return The securityRequirements to add to the Endpoint entry in the spec file.
     */
    public List getSecurityRequirements() {
        return securityRequirements;
    }

    /**
     * Sets the securityRequirements to add to the Endpoint entry in the spec file.
     *
     * @param securityRequirements A list of securityRequirements.
     */
    public void setSecurityRequirements(List securityRequirements) {
        this.securityRequirements = securityRequirements;
    }

    @Override
    public String toString() {
        return "Endpoint [element=" + element + ", tags=" + tags + ", servers=" + servers + ", securityRequirements="
            + securityRequirements + "]";
    }

}