io.swagger.v3.oas.models.PathItem Maven / Gradle / Ivy
/**
* 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 io.swagger.v3.oas.models;
import io.swagger.v3.oas.models.parameters.Parameter;
import io.swagger.v3.oas.models.servers.Server;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
/**
* PathItem
*
* @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#pathItemObject"
*/
public class PathItem {
private String summary = null;
private String description = null;
private Operation get = null;
private Operation put = null;
private Operation post = null;
private Operation delete = null;
private Operation options = null;
private Operation head = null;
private Operation patch = null;
private Operation trace = null;
private List servers = null;
private List parameters = null;
private String $ref = null;
private java.util.Map extensions = null;
/**
* returns the summary property from a PathItem instance.
*
* @return String summary
**/
public String getSummary() {
return summary;
}
public void setSummary(String summary) {
this.summary = summary;
}
public PathItem summary(String summary) {
this.summary = summary;
return this;
}
/**
* returns the description property from a PathItem instance.
*
* @return String description
**/
public String getDescription() {
return description;
}
public void setDescription(String description) {
this.description = description;
}
public PathItem description(String description) {
this.description = description;
return this;
}
/**
* returns the get property from a PathItem instance.
*
* @return Operation get
**/
public Operation getGet() {
return get;
}
public void setGet(Operation get) {
this.get = get;
}
public PathItem get(Operation get) {
this.get = get;
return this;
}
/**
* returns the put property from a PathItem instance.
*
* @return Operation put
**/
public Operation getPut() {
return put;
}
public void setPut(Operation put) {
this.put = put;
}
public PathItem put(Operation put) {
this.put = put;
return this;
}
/**
* returns the post property from a PathItem instance.
*
* @return Operation post
**/
public Operation getPost() {
return post;
}
public void setPost(Operation post) {
this.post = post;
}
public PathItem post(Operation post) {
this.post = post;
return this;
}
/**
* returns the delete property from a PathItem instance.
*
* @return Operation delete
**/
public Operation getDelete() {
return delete;
}
public void setDelete(Operation delete) {
this.delete = delete;
}
public PathItem delete(Operation delete) {
this.delete = delete;
return this;
}
/**
* returns the options property from a PathItem instance.
*
* @return Operation options
**/
public Operation getOptions() {
return options;
}
public void setOptions(Operation options) {
this.options = options;
}
public PathItem options(Operation options) {
this.options = options;
return this;
}
/**
* returns the head property from a PathItem instance.
*
* @return Operation head
**/
public Operation getHead() {
return head;
}
public void setHead(Operation head) {
this.head = head;
}
public PathItem head(Operation head) {
this.head = head;
return this;
}
/**
* returns the patch property from a PathItem instance.
*
* @return Operation patch
**/
public Operation getPatch() {
return patch;
}
public void setPatch(Operation patch) {
this.patch = patch;
}
public PathItem patch(Operation patch) {
this.patch = patch;
return this;
}
/**
* returns the trace property from a PathItem instance.
*
* @return Operation trace
**/
public Operation getTrace() {
return trace;
}
public void setTrace(Operation trace) {
this.trace = trace;
}
public PathItem trace(Operation trace) {
this.trace = trace;
return this;
}
public List readOperations() {
List allOperations = new ArrayList<>();
if (this.get != null) {
allOperations.add(this.get);
}
if (this.put != null) {
allOperations.add(this.put);
}
if (this.head != null) {
allOperations.add(this.head);
}
if (this.post != null) {
allOperations.add(this.post);
}
if (this.delete != null) {
allOperations.add(this.delete);
}
if (this.patch != null) {
allOperations.add(this.patch);
}
if (this.options != null) {
allOperations.add(this.options);
}
if (this.trace != null) {
allOperations.add(this.trace);
}
return allOperations;
}
public void operation(HttpMethod method, Operation operation) {
switch (method) {
case PATCH:
this.patch = operation;
break;
case POST:
this.post = operation;
break;
case PUT:
this.put = operation;
break;
case GET:
this.get = operation;
break;
case OPTIONS:
this.options = operation;
break;
case TRACE:
this.trace = operation;
break;
case HEAD:
this.head = operation;
break;
case DELETE:
this.delete = operation;
break;
default:
}
}
public enum HttpMethod {
POST,
GET,
PUT,
PATCH,
DELETE,
HEAD,
OPTIONS,
TRACE
}
public Map readOperationsMap() {
Map result = new LinkedHashMap<>();
if (this.get != null) {
result.put(HttpMethod.GET, this.get);
}
if (this.put != null) {
result.put(HttpMethod.PUT, this.put);
}
if (this.post != null) {
result.put(HttpMethod.POST, this.post);
}
if (this.delete != null) {
result.put(HttpMethod.DELETE, this.delete);
}
if (this.patch != null) {
result.put(HttpMethod.PATCH, this.patch);
}
if (this.head != null) {
result.put(HttpMethod.HEAD, this.head);
}
if (this.options != null) {
result.put(HttpMethod.OPTIONS, this.options);
}
if (this.trace != null) {
result.put(HttpMethod.TRACE, this.trace);
}
return result;
}
/**
* returns the servers property from a PathItem instance.
*
* @return List<Server> servers
**/
public List getServers() {
return servers;
}
public void setServers(List servers) {
this.servers = servers;
}
public PathItem servers(List servers) {
this.servers = servers;
return this;
}
public PathItem addServersItem(Server serversItem) {
if (this.servers == null) {
this.servers = new ArrayList<>();
}
this.servers.add(serversItem);
return this;
}
/**
* returns the parameters property from a PathItem instance.
*
* @return List<Parameter> parameters
**/
public List getParameters() {
return parameters;
}
public void setParameters(List parameters) {
this.parameters = parameters;
}
public PathItem parameters(List parameters) {
this.parameters = parameters;
return this;
}
public PathItem addParametersItem(Parameter parametersItem) {
if (this.parameters == null) {
this.parameters = new ArrayList<>();
}
this.parameters.add(parametersItem);
return this;
}
public java.util.Map getExtensions() {
return extensions;
}
public void addExtension(String name, Object value) {
if (name == null || name.isEmpty() || !name.startsWith("x-")) {
return;
}
if (this.extensions == null) {
this.extensions = new java.util.LinkedHashMap<>();
}
this.extensions.put(name, value);
}
public void setExtensions(java.util.Map extensions) {
this.extensions = extensions;
}
public PathItem extensions(java.util.Map extensions) {
this.extensions = extensions;
return this;
}
/**
* returns the ref property from a PathItem instance.
*
* @return String ref
**/
public String get$ref() {
return $ref;
}
public void set$ref(String $ref) {
this.$ref = $ref;
}
public PathItem $ref(String $ref) {
set$ref($ref);
return this;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (!(o instanceof PathItem)) {
return false;
}
PathItem pathItem = (PathItem) o;
if (summary != null ? !summary.equals(pathItem.summary) : pathItem.summary != null) {
return false;
}
if (description != null ? !description.equals(pathItem.description) : pathItem.description != null) {
return false;
}
if (get != null ? !get.equals(pathItem.get) : pathItem.get != null) {
return false;
}
if (put != null ? !put.equals(pathItem.put) : pathItem.put != null) {
return false;
}
if (post != null ? !post.equals(pathItem.post) : pathItem.post != null) {
return false;
}
if (delete != null ? !delete.equals(pathItem.delete) : pathItem.delete != null) {
return false;
}
if (options != null ? !options.equals(pathItem.options) : pathItem.options != null) {
return false;
}
if (head != null ? !head.equals(pathItem.head) : pathItem.head != null) {
return false;
}
if (patch != null ? !patch.equals(pathItem.patch) : pathItem.patch != null) {
return false;
}
if (trace != null ? !trace.equals(pathItem.trace) : pathItem.trace != null) {
return false;
}
if (servers != null ? !servers.equals(pathItem.servers) : pathItem.servers != null) {
return false;
}
if (parameters != null ? !parameters.equals(pathItem.parameters) : pathItem.parameters != null) {
return false;
}
if ($ref != null ? !$ref.equals(pathItem.$ref) : pathItem.$ref != null) {
return false;
}
return extensions != null ? extensions.equals(pathItem.extensions) : pathItem.extensions == null;
}
@Override
public int hashCode() {
int result = summary != null ? summary.hashCode() : 0;
result = 31 * result + (description != null ? description.hashCode() : 0);
result = 31 * result + (get != null ? get.hashCode() : 0);
result = 31 * result + (put != null ? put.hashCode() : 0);
result = 31 * result + (post != null ? post.hashCode() : 0);
result = 31 * result + (delete != null ? delete.hashCode() : 0);
result = 31 * result + (options != null ? options.hashCode() : 0);
result = 31 * result + (head != null ? head.hashCode() : 0);
result = 31 * result + (patch != null ? patch.hashCode() : 0);
result = 31 * result + (trace != null ? trace.hashCode() : 0);
result = 31 * result + (servers != null ? servers.hashCode() : 0);
result = 31 * result + (parameters != null ? parameters.hashCode() : 0);
result = 31 * result + ($ref != null ? $ref.hashCode() : 0);
result = 31 * result + (extensions != null ? extensions.hashCode() : 0);
return result;
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class PathItem {\n");
sb.append(" summary: ").append(toIndentedString(summary)).append("\n");
sb.append(" description: ").append(toIndentedString(description)).append("\n");
sb.append(" get: ").append(toIndentedString(get)).append("\n");
sb.append(" put: ").append(toIndentedString(put)).append("\n");
sb.append(" post: ").append(toIndentedString(post)).append("\n");
sb.append(" delete: ").append(toIndentedString(delete)).append("\n");
sb.append(" options: ").append(toIndentedString(options)).append("\n");
sb.append(" head: ").append(toIndentedString(head)).append("\n");
sb.append(" patch: ").append(toIndentedString(patch)).append("\n");
sb.append(" trace: ").append(toIndentedString(trace)).append("\n");
sb.append(" servers: ").append(toIndentedString(servers)).append("\n");
sb.append(" parameters: ").append(toIndentedString(parameters)).append("\n");
sb.append(" $ref: ").append(toIndentedString($ref)).append("\n");
sb.append("}");
return sb.toString();
}
/**
* Convert the given object to string with each line indented by 4 spaces
* (except the first line).
*/
private String toIndentedString(java.lang.Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
}