com.networknt.oas.model.Response Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of openapi-parser Show documentation

A light-weight, fast OpenAPI 3.0 parser and validator

The newest version!

/*******************************************************************************
 *  Copyright (c) 2017 ModelSolv, Inc. and others.
 *  All rights reserved. This program and the accompanying materials
 *  are made available under the terms of the Eclipse Public License v1.0
 *  which accompanies this distribution, and is available at
 *  http://www.eclipse.org/legal/epl-v10.html
 *
 *  Contributors:
 *     ModelSolv, Inc. - initial API and implementation and/or initial documentation
 *******************************************************************************/
package com.networknt.oas.model;

import java.util.Map;

import com.networknt.jsonoverlay.IJsonOverlay;
import com.networknt.jsonoverlay.IModelPart;

public interface Response extends IJsonOverlay, IModelPart {

	String getName();

	// Description
	String getDescription();

	void setDescription(String description);

	// Header
	Map getHeaders();

	Map getHeaders(boolean elaborate);

	boolean hasHeaders();

	boolean hasHeader(String name);

	Header getHeader(String name);

	void setHeaders(Map headers);

	void setHeader(String name, Header header);

	void removeHeader(String name);

	// ContentMediaType
	Map getContentMediaTypes();

	Map getContentMediaTypes(boolean elaborate);

	boolean hasContentMediaTypes();

	boolean hasContentMediaType(String name);

	MediaType getContentMediaType(String name);

	void setContentMediaTypes(Map contentMediaTypes);

	void setContentMediaType(String name, MediaType contentMediaType);

	void removeContentMediaType(String name);

	// Link
	Map getLinks();

	Map getLinks(boolean elaborate);

	boolean hasLinks();

	boolean hasLink(String name);

	Link getLink(String name);

	void setLinks(Map links);

	void setLink(String name, Link link);

	void removeLink(String name);

	// Extension
	Map getExtensions();

	Map getExtensions(boolean elaborate);

	boolean hasExtensions();

	boolean hasExtension(String name);

	Object getExtension(String name);

	void setExtensions(Map extensions);

	void setExtension(String name, Object extension);

	void removeExtension(String name);
}