Interface ServerVariables
-
- All Superinterfaces:
Constructible
,Extensible<ServerVariables>
,java.util.Map<java.lang.String,ServerVariable>
@Deprecated public interface ServerVariables extends Constructible, Extensible<ServerVariables>, java.util.Map<java.lang.String,ServerVariable>
Deprecated.since 1.1, a future version will remove this and replace it with aMap<String, ServerVariable>
, because it does not need to be extensibleServerVariables- See Also:
- ServerVariable Object
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description ServerVariables
addServerVariable(java.lang.String name, ServerVariable serverVariable)
Deprecated.This method adds a key-value item to a ServerVariables instance from the name-item parameter pair and returns the modified instance.boolean
containsKey(java.lang.Object key)
Deprecated.since 1.1ServerVariable
get(java.lang.Object key)
Deprecated.since 1.1default ServerVariable
getServerVariable(java.lang.String name)
Deprecated.Returns a server variable for a given name.java.util.Map<java.lang.String,ServerVariable>
getServerVariables()
Deprecated.Returns a copy map (potentially immutable) of the server variables.default boolean
hasServerVariable(java.lang.String name)
Deprecated.Check whether a server variable is present in the map.ServerVariable
put(java.lang.String key, ServerVariable value)
Deprecated.since 1.1void
putAll(java.util.Map<? extends java.lang.String,? extends ServerVariable> m)
Deprecated.since 1.1ServerVariable
remove(java.lang.Object key)
Deprecated.since 1.1void
removeServerVariable(java.lang.String name)
Deprecated.Removes the given server variables.void
setServerVariables(java.util.Map<java.lang.String,ServerVariable> items)
Deprecated.Set the server variables map to this ServerVariables object.-
Methods inherited from interface org.eclipse.microprofile.openapi.models.Extensible
addExtension, extensions, getExtensions, removeExtension, setExtensions
-
-
-
-
Method Detail
-
addServerVariable
ServerVariables addServerVariable(java.lang.String name, ServerVariable serverVariable)
Deprecated.This method adds a key-value item to a ServerVariables instance from the name-item parameter pair and returns the modified instance.- Parameters:
name
- the name of ServerVariable instanceserverVariable
- the ServerVariable instance. null values will be rejected (implementation will throw an exception) or ignored.- Returns:
- ServerVariables instance with the added name-item pair.
-
removeServerVariable
void removeServerVariable(java.lang.String name)
Deprecated.Removes the given server variables.- Parameters:
name
- the name of ServerVariable instance
-
getServerVariables
java.util.Map<java.lang.String,ServerVariable> getServerVariables()
Deprecated.Returns a copy map (potentially immutable) of the server variables.- Returns:
- all items
-
setServerVariables
void setServerVariables(java.util.Map<java.lang.String,ServerVariable> items)
Deprecated.Set the server variables map to this ServerVariables object.- Parameters:
items
- a map containing key-value item.
-
hasServerVariable
default boolean hasServerVariable(java.lang.String name)
Deprecated.Check whether a server variable is present in the map. This is a convenience method forgetServerVariables().containsKey(name)
- Parameters:
name
- the name of ServerVariable instance- Returns:
- a boolean to indicate if the server variable is present or not.
-
getServerVariable
default ServerVariable getServerVariable(java.lang.String name)
Deprecated.Returns a server variable for a given name. This is a convenience method forgetServerVariables().get(name)
- Parameters:
name
- the name of ServerVariable instance- Returns:
- the corresponding server variable or null.
-
get
@Deprecated ServerVariable get(java.lang.Object key)
Deprecated.since 1.1In the next version,ServerVariables
will no longer extendsMap
, this method will no longer be present. UsegetServerVariable(String)
instead.- Specified by:
get
in interfacejava.util.Map<java.lang.String,ServerVariable>
-
containsKey
@Deprecated boolean containsKey(java.lang.Object key)
Deprecated.since 1.1In the next version,ServerVariables
will no longer extendsMap
, this method will no longer be present. UsehasServerVariable(String)
instead.- Specified by:
containsKey
in interfacejava.util.Map<java.lang.String,ServerVariable>
-
put
@Deprecated ServerVariable put(java.lang.String key, ServerVariable value)
Deprecated.since 1.1In the next version,ServerVariables
will no longer extendsMap
, this method will no longer be present. UseaddServerVariable(String, ServerVariable)
instead.- Specified by:
put
in interfacejava.util.Map<java.lang.String,ServerVariable>
-
putAll
@Deprecated void putAll(java.util.Map<? extends java.lang.String,? extends ServerVariable> m)
Deprecated.since 1.1In the next version,ServerVariables
will no longer extendsMap
, this method will no longer be present. UsesetServerVariables(Map)
instead.- Specified by:
putAll
in interfacejava.util.Map<java.lang.String,ServerVariable>
-
remove
@Deprecated ServerVariable remove(java.lang.Object key)
Deprecated.since 1.1In the next version,ServerVariables
will no longer extendsMap
, this method will no longer be present. UseremoveServerVariable(String)
instead.- Specified by:
remove
in interfacejava.util.Map<java.lang.String,ServerVariable>
-
-