com.networknt.oas.model.Header 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
There is a newer version: 2.1.38
/*******************************************************************************
 *  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 Header extends IJsonOverlay, IModelPart {

	String getKey();

	// Description
	String getDescription();

	void setDescription(String description);

	// Required
	Boolean getRequired();

	boolean isRequired();

	void setRequired(Boolean required);

	// Deprecated
	Boolean getDeprecated();

	boolean isDeprecated();

	void setDeprecated(Boolean deprecated);

	// AllowEmptyValue
	Boolean getAllowEmptyValue();

	boolean isAllowEmptyValue();

	void setAllowEmptyValue(Boolean allowEmptyValue);

	// Style
	String getStyle();

	void setStyle(String style);

	// Explode
	Boolean getExplode();

	boolean isExplode();

	void setExplode(Boolean explode);

	// AllowReserved
	Boolean getAllowReserved();

	boolean isAllowReserved();

	void setAllowReserved(Boolean allowReserved);

	// Schema
	Schema getSchema();

	Schema getSchema(boolean elaborate);

	void setSchema(Schema schema);

	// Example
	Object getExample();

	void setExample(Object example);

	// Example
	Map getExamples();

	Map getExamples(boolean elaborate);

	boolean hasExamples();

	boolean hasExample(String name);

	Example getExample(String name);

	void setExamples(Map examples);

	void setExample(String name, Example example);

	void removeExample(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);

	// 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);
}