/
Extensible.java
79 lines (70 loc) · 2.77 KB
/
Extensible.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
/**
* Copyright (c) 2017 Contributors to the Eclipse Foundation
* Copyright 2017 SmartBear Software
* <p>
* 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
* <p>
* http://www.apache.org/licenses/LICENSE-2.0
* <p>
* 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;
/**
* The base interface for OpenAPI model objects that can contain extensions. Extensions contain data not required by the
* specification and may or may not be supported by the tools you use.
* <p>
* The extensions property names are always prefixed by "x-".
*/
public interface Extensible<T extends Extensible<T>> {
/**
* Returns the extensions property from an Extensible instance.
*
* @return a map containing keys which start with "x-" and values which provide additional information
**/
Map<String, Object> getExtensions();
/**
* Sets this Extensible's extensions property to the given map of extensions.
*
* @param extensions
* map containing keys which start with "x-" and values which provide additional information
* @return the current instance
*/
default T extensions(Map<String, Object> extensions) {
setExtensions(extensions);
@SuppressWarnings("unchecked")
T t = (T) this;
return t;
}
/**
* Adds the given object to this Extensible's map of extensions, with the given name as its key.
*
* @param name
* the key used to access the extension object. Always prefixed by "x-".
* @param value
* data not required by the specification. null values will be rejected (implementation will throw an
* exception) or ignored.
* @return the current instance
*/
T addExtension(String name, Object value);
/**
* Removes the given object to this Extensible's map of extensions, with the given name as its key.
*
* @param name
* the key used to access the extension object. Always prefixed by "x-".
*/
void removeExtension(String name);
/**
* Sets this Extensible's extensions property to the given map of extensions.
*
* @param extensions
* map containing keys which start with "x-" and values which provide additional information
*/
void setExtensions(Map<String, Object> extensions);
}