io.micronaut.openapi.javadoc.JavadocDescription 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.javadoc;

import io.micronaut.core.annotation.Nullable;

import java.util.HashMap;
import java.util.Map;

/**
 * A parsed javadoc description.
 *
 * @author graemerocher
 * @since 1.0
 */
public class JavadocDescription {

    private String methodSummary;
    private String methodDescription;
    private String returnDescription;
    private String deprecatedDescription;
    private final Map parameters = new HashMap<>(4);

    /**
     * @return method summary
     */
    public String getMethodSummary() {
        return methodSummary;
    }

    /**
     * Sets the method summary.
     *
     * @param methodSummary The method summary
     */
    public void setMethodSummary(String methodSummary) {
        this.methodSummary = methodSummary;
    }

    /**
     * @return The description
     */
    @Nullable
    public String getMethodDescription() {
        return methodDescription;
    }

    /**
     * Sets the method description.
     *
     * @param methodDescription The method description
     */
    public void setMethodDescription(String methodDescription) {
        this.methodDescription = methodDescription;
    }

    /**
     * @return The parameter descriptions
     */
    public Map getParameters() {
        return parameters;
    }

    /**
     * The return description.
     *
     * @return The return description
     */
    @Nullable
    public String getReturnDescription() {
        return returnDescription;
    }

    /**
     * Sets the return description.
     *
     * @param returnDescription The return description.
     */
    public void setReturnDescription(String returnDescription) {
        this.returnDescription = returnDescription;
    }

    /**
     * The deprecated description.
     *
     * @return The deprecated description
     */
    @Nullable
    public String getDeprecatedDescription() {
        return deprecatedDescription;
    }

    /**
     * Sets the deprecated description.
     *
     * @param deprecatedDescription The deprecated description.
     */
    public void setDeprecatedDescription(String deprecatedDescription) {
        this.deprecatedDescription = deprecatedDescription;
    }
}