org.eclipse.microprofile.openapi.models.media.Content Maven / Gradle / Ivy

Go to download
/**
 * Copyright (c) 2017 Contributors to the Eclipse Foundation
 * Copyright 2017 SmartBear Software
 * 
 * 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 org.eclipse.microprofile.openapi.models.media;

import java.util.Map;

import org.eclipse.microprofile.openapi.models.Constructible;

/**
 * Content
 * 
 * A map to assist describing the media types for an operation's parameter or response.
 *
 */
public interface Content extends Constructible {

    /**
     * Adds the MediaType for this Content, where the key is the name of the MediaType and the value is the object that
     * describes the content passed into or returned from an operation.
     *
     * @param name
     *            the name of a media type e.g. application/json.
     * @param mediaType
     *            an object that describes the content passed into or returned from an operation. null values will be
     *            rejected (implementation will throw an exception) or ignored.
     * @return the current Content instance
     */
    Content addMediaType(String name, MediaType mediaType);

    /**
     * Removes the given MediaType for this Content by its name.
     *
     * @param name
     *            a path name that will be removed.
     */
    void removeMediaType(String name);

    /**
     * Returns a copy map (potentially immutable) of media types.
     *
     * @return all items
     */
    Map getMediaTypes();

    /**
     * Set the media types map to this Content
     *
     * @param mediaTypes
     *            a map containing the list of media types. Keys are name of a media type e.g. application/json.
     */
    void setMediaTypes(Map mediaTypes);

    /**
     * Check whether a media type is present in the map. This is a convenience method for
     * getMediaTypes().containsKey(name)
     *
     * @param name
     *            the name of a media type e.g. application/json.
     * @return a boolean to indicate if the media type is present or not.
     */
    default boolean hasMediaType(String name) {
        Map map = getMediaTypes();
        if (map == null) {
            return false;
        }
        return map.containsKey(name);
    }

    /**
     * Returns a media type for a given name. This is a convenience method for getMediaTypes().get(name)
     *
     * @param name
     *            the name of a media type e.g. application/json.
     * @return the corresponding media type or null.
     */
    default MediaType getMediaType(String name) {
        Map map = getMediaTypes();
        if (map == null) {
            return null;
        }
        return map.get(name);
    }

}