Interface Paths
-
- All Superinterfaces:
Constructible
,Extensible<Paths>
,java.util.Map<java.lang.String,PathItem>
public interface Paths extends Constructible, Extensible<Paths>, java.util.Map<java.lang.String,PathItem>
PathsHolds 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 Also:
- OpenAPI Specification Paths Object
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description Paths
addPathItem(java.lang.String name, PathItem item)
Adds the given path item to this Paths and return this instance of Pathsboolean
containsKey(java.lang.Object key)
Deprecated.since 1.1PathItem
get(java.lang.Object key)
Deprecated.since 1.1default PathItem
getPathItem(java.lang.String name)
Returns a path item for a given name.java.util.Map<java.lang.String,PathItem>
getPathItems()
Returns a copy map (potentially immutable) of the path items.default boolean
hasPathItem(java.lang.String name)
Check whether a path item is present in the map.PathItem
put(java.lang.String key, PathItem value)
Deprecated.since 1.1void
putAll(java.util.Map<? extends java.lang.String,? extends PathItem> m)
Deprecated.since 1.1PathItem
remove(java.lang.Object key)
Deprecated.since 1.1void
removePathItem(java.lang.String name)
Removes the given path item to this Paths.void
setPathItems(java.util.Map<java.lang.String,PathItem> items)
Set the path items map to this Paths-
Methods inherited from interface org.eclipse.microprofile.openapi.models.Extensible
addExtension, extensions, getExtensions, removeExtension, setExtensions
-
-
-
-
Method Detail
-
addPathItem
Paths addPathItem(java.lang.String name, PathItem item)
Adds the given path item to this Paths and return this instance of Paths- Parameters:
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.- Returns:
- the current Paths instance
-
removePathItem
void removePathItem(java.lang.String name)
Removes the given path item to this Paths.- Parameters:
name
- a path name that will be removed.
-
getPathItems
java.util.Map<java.lang.String,PathItem> getPathItems()
Returns a copy map (potentially immutable) of the path items.- Returns:
- all items
-
setPathItems
void setPathItems(java.util.Map<java.lang.String,PathItem> items)
Set the path items map to this Paths- Parameters:
items
- a map containing the list of paths. Keys MUST begin with a slash.
-
hasPathItem
default boolean hasPathItem(java.lang.String name)
Check whether a path item is present in the map. This is a convenience method forgetPathItems().containsKey(name)
- Parameters:
name
- a path name in the format valid for a Paths object.- Returns:
- a boolean to indicate if the path item is present or not.
-
getPathItem
default PathItem getPathItem(java.lang.String name)
Returns a path item for a given name. This is a convenience method forgetPathItems().get(name)
- Parameters:
name
- a path name in the format valid for a Paths object.- Returns:
- the corresponding path item or null.
-
get
@Deprecated PathItem get(java.lang.Object key)
Deprecated.since 1.1In the next version,Paths
will no longer extendsMap
, this method will no longer be present. UsegetPathItem(String)
instead.- Specified by:
get
in interfacejava.util.Map<java.lang.String,PathItem>
-
containsKey
@Deprecated boolean containsKey(java.lang.Object key)
Deprecated.since 1.1In the next version,Paths
will no longer extendsMap
, this method will no longer be present. UsehasPathItem(String)
instead.- Specified by:
containsKey
in interfacejava.util.Map<java.lang.String,PathItem>
-
put
@Deprecated PathItem put(java.lang.String key, PathItem value)
Deprecated.since 1.1In the next version,Paths
will no longer extendsMap
, this method will no longer be present. UseaddPathItem(String, PathItem)
instead.- Specified by:
put
in interfacejava.util.Map<java.lang.String,PathItem>
-
putAll
@Deprecated void putAll(java.util.Map<? extends java.lang.String,? extends PathItem> m)
Deprecated.since 1.1In the next version,Paths
will no longer extendsMap
, this method will no longer be present. UsesetPathItems(Map)
instead.- Specified by:
putAll
in interfacejava.util.Map<java.lang.String,PathItem>
-
remove
@Deprecated PathItem remove(java.lang.Object key)
Deprecated.since 1.1In the next version,Paths
will no longer extendsMap
, this method will no longer be present. UseremovePathItem(String)
instead.- Specified by:
remove
in interfacejava.util.Map<java.lang.String,PathItem>
-
-