org.eclipse.microprofile.openapi.models.Paths Maven / Gradle / Ivy
/**
* 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;
import java.util.Map;
/**
* Paths
*
* Holds the relative paths to the individual endpoints and their operations. The path is appended to the URL from the
* Server Object in order to construct the full URL. The Paths MAY be empty, due to
* security constraints.
*
*
* @see OpenAPI Specification Paths Object
*/
public interface Paths extends Constructible, Extensible {
/**
* Adds the given path item to this Paths and return this instance of Paths
*
* @param name
* a path name in the format valid for a Paths object. The field name MUST begin with a slash.
* @param item
* the path item added to the list of paths. null values will be rejected (implementation will throw an
* exception) or ignored.
* @return the current Paths instance
*/
Paths addPathItem(String name, PathItem item);
/**
* Removes the given path item to this Paths.
*
* @param name
* a path name that will be removed.
*/
void removePathItem(String name);
/**
* Returns a copy map (potentially immutable) of the path items.
*
* @return all items
*/
Map getPathItems();
/**
* Set the path items map to this Paths
*
* @param items
* a map containing the list of paths. Keys MUST begin with a slash.
*/
void setPathItems(Map items);
/**
* Check whether a path item is present in the map. This is a convenience method for
* getPathItems().containsKey(name)
*
* @param name
* a path name in the format valid for a Paths object.
* @return a boolean to indicate if the path item is present or not.
*/
default boolean hasPathItem(String name) {
Map map = getPathItems();
if (map == null) {
return false;
}
return map.containsKey(name);
}
/**
* Returns a path item for a given name. This is a convenience method for getPathItems().get(name)
*
* @param name
* a path name in the format valid for a Paths object.
* @return the corresponding path item or null.
*/
default PathItem getPathItem(String name) {
Map map = getPathItems();
if (map == null) {
return null;
}
return map.get(name);
}
}