public interface Paths extends Constructible, Extensible<Paths>, Map<String,PathItem>
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.
Modifier and Type | Method and Description |
---|---|
Paths |
addPathItem(String name,
PathItem item)
Adds the given path item to this Paths and return this instance of Paths
|
boolean |
containsKey(Object key)
Deprecated.
since 1.1
|
PathItem |
get(Object key)
Deprecated.
since 1.1
|
default PathItem |
getPathItem(String name)
Returns a path item for a given name.
|
Map<String,PathItem> |
getPathItems()
Returns a copy map (potentially immutable) of the path items.
|
default boolean |
hasPathItem(String name)
Check whether a path item is present in the map.
|
PathItem |
put(String key,
PathItem value)
Deprecated.
since 1.1
|
void |
putAll(Map<? extends String,? extends PathItem> m)
Deprecated.
since 1.1
|
PathItem |
remove(Object key)
Deprecated.
since 1.1
|
void |
removePathItem(String name)
Removes the given path item to this Paths.
|
void |
setPathItems(Map<String,PathItem> items)
Set the path items map to this Paths
|
addExtension, extensions, getExtensions, removeExtension, setExtensions
clear, compute, computeIfAbsent, computeIfPresent, containsValue, entrySet, equals, forEach, getOrDefault, hashCode, isEmpty, keySet, merge, putIfAbsent, remove, replace, replace, replaceAll, size, values
Paths addPathItem(String name, PathItem item)
name
- a path name in the format valid for a Paths object. The field name MUST begin with a slash.item
- the path item added to the list of paths. null values will be rejected (implementation will throw an exception) or ignored.void removePathItem(String name)
name
- a path name that will be removed.Map<String,PathItem> getPathItems()
void setPathItems(Map<String,PathItem> items)
items
- a map containing the list of paths. Keys MUST begin with a slash.default boolean hasPathItem(String name)
getPathItems().containsKey(name)
name
- a path name in the format valid for a Paths object.default PathItem getPathItem(String name)
getPathItems().get(name)
name
- a path name in the format valid for a Paths object.@Deprecated PathItem get(Object key)
Paths
will no longer extends Map
, this method will no longer be present.
Use getPathItem(String)
instead.@Deprecated boolean containsKey(Object key)
Paths
will no longer extends Map
, this method will no longer be present.
Use hasPathItem(String)
instead.containsKey
in interface Map<String,PathItem>
@Deprecated PathItem put(String key, PathItem value)
Paths
will no longer extends Map
, this method will no longer be present.
Use addPathItem(String, PathItem)
instead.@Deprecated void putAll(Map<? extends String,? extends PathItem> m)
Paths
will no longer extends Map
, this method will no longer be present.
Use setPathItems(Map)
instead.@Deprecated PathItem remove(Object key)
Paths
will no longer extends Map
, this method will no longer be present.
Use removePathItem(String)
instead.Copyright © 2017 – 2021 Eclipse Foundation. All rights reserved.
Use is subject to license terms.