public interface Callback extends Constructible, Extensible<Callback>, Reference<Callback>, Map<String,PathItem>
A map of possible out-of-band callbacks related to the parent operation. Each value in the map is a Path Item Object that describes a set of requests that may be initiated by the API provider and the expected responses. The key value used to identify the callback object is an expression, evaluated at runtime, that identifies a URL to use for the callback operation.
Modifier and Type | Method and Description |
---|---|
Callback |
addPathItem(String name,
PathItem pathItem)
Adds the given PathItem to this Callback's list of PathItems using the string as its key.
|
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 to 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 of the Callback PathItems.
|
void |
setPathItems(Map<String,PathItem> items)
Set the path items map to this Callback.
|
addExtension, extensions, getExtensions, removeExtension, setExtensions
getRef, ref, setRef
clear, compute, computeIfAbsent, computeIfPresent, containsValue, entrySet, equals, forEach, getOrDefault, hashCode, isEmpty, keySet, merge, putIfAbsent, remove, replace, replace, replaceAll, size, values
Callback addPathItem(String name, PathItem pathItem)
name
- a runtime expression that can be evaluated in the context of a runtime HTTP request/responsepathItem
- a path to add to this Callback's list of PathItems. 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.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)
Callback
will no longer extends Map
, this method will no longer be present.
Use getPathItem(String)
instead.@Deprecated boolean containsKey(Object key)
Callback
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)
Callback
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)
Callback
will no longer extends Map
, this method will no longer be present.
Use setPathItems(Map)
instead.@Deprecated PathItem remove(Object key)
Callback
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.