io.apicurio.datamodels.openapi.v3.models.Oas30Response Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2019 Red Hat
 *
 * 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 io.apicurio.datamodels.openapi.v3.models;

import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;

import io.apicurio.datamodels.openapi.models.OasResponse;

/**
 * Models an OpenAPI 3.0.x response.
 * @author [email protected]
 */
public class Oas30Response extends OasResponse implements IOas30MediaTypeParent {

    public Map headers = new LinkedHashMap<>();
    public Map content = new LinkedHashMap<>();
    public Map links = new LinkedHashMap<>();

    /**
     * Constructor.
     * @param statusCode
     */
    public Oas30Response(String statusCode) {
        super(statusCode);
    }

    /**
     * Gets the status code.
     */
    public String getStatusCode() {
        return this.getName();
    }

    /**
     * Creates a header.
     * @param name
     */
    public Oas30Header createHeader(String name) {
        Oas30Header rval = new Oas30Header(name);
        rval._ownerDocument = this.ownerDocument();
        rval._parent = this;
        return rval;
    }

    /**
     * Adds a header.
     * @param name
     * @param header
     */
    public void addHeader(String name, Oas30Header header) {
        this.headers.put(name, header);
    }

    /**
     * Gets a single header by name.
     * @param name
     */
    public Oas30Header getHeader(String name) {
        return this.headers.get(name);
    }

    /**
     * Removes a single header and returns it.  This may return null or undefined if none found.
     * @param name
     */
    public Oas30Header removeHeader(String name) {
        return this.headers.remove(name);
    }

    /**
     * Gets a list of all headers.
     */
    public List getHeaders() {
        List rval = new ArrayList<>();
        rval.addAll(this.headers.values());
        return rval;
    }

    /**
     * @see io.apicurio.datamodels.openapi.v3.models.IOas30MediaTypeParent#createMediaType(java.lang.String)
     */
    @Override
    public Oas30MediaType createMediaType(String name) {
        Oas30MediaType rval = new Oas30MediaType(name);
        rval._ownerDocument = this.ownerDocument();
        rval._parent = this;
        return rval;
    }

    /**
     * @see io.apicurio.datamodels.openapi.v3.models.IOas30MediaTypeParent#addMediaType(java.lang.String, io.apicurio.datamodels.openapi.v3.models.Oas30MediaType)
     */
    @Override
    public void addMediaType(String name, Oas30MediaType mediaType) {
        this.content.put(name, mediaType);
    }

    /**
     * @see io.apicurio.datamodels.openapi.v3.models.IOas30MediaTypeParent#getMediaType(java.lang.String)
     */
    @Override
    public Oas30MediaType getMediaType(String name) {
        return this.content.get(name);
    }

    /**
     * @see io.apicurio.datamodels.openapi.v3.models.IOas30MediaTypeParent#removeMediaType(java.lang.String)
     */
    @Override
    public Oas30MediaType removeMediaType(String name) {
        return this.content.remove(name);
    }

    /**
     * @see io.apicurio.datamodels.openapi.v3.models.IOas30MediaTypeParent#getMediaTypes()
     */
    @Override
    public List getMediaTypes() {
        List rval = new ArrayList<>();
        rval.addAll(this.content.values());
        return rval;
    }

    /**
     * Creates a link.
     * @param name
     */
    public Oas30Link createLink(String name) {
        Oas30Link rval = new Oas30Link(name);
        rval._ownerDocument = this.ownerDocument();
        rval._parent = this;
        return rval;
    }

    /**
     * Adds a link.
     * @param name
     * @param link
     */
    public void addLink(String name, Oas30Link link) {
        this.links.put(name, link);
    }

    /**
     * Gets a single link by name.
     * @param name
     */
    public Oas30Link getLink(String name) {
        return this.links.get(name);
    }

    /**
     * Removes a single link and returns it.  This may return null or undefined if none found.
     * @param name
     */
    public Oas30Link removeLink(String name) {
        return this.links.remove(name);
    }

    /**
     * Gets a list of all links.
     */
    public List getLinks() {
        List rval = new ArrayList<>();
        rval.addAll(this.links.values());
        return rval;
    }

}