Graal Sdk 24.1.2 · org.graalvm.options.OptionMap · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
pack-priv final Map<String, T>	backingMap
private static final OptionMap<?>	EMPTY
pack-priv final Map<String, T>	readonlyMap

Access	Constructor and Description
pack-priv	OptionMap(Map<String, T> map)

Method Summary

Modifier and Type	Method and Description
public static < the class of the map values T> OptionMap<T>	Returns: an empty option map empty() Returns an empty option map (immutable).
public Set<Map.Entry<String, T>>	Returns: a set view of the mappings contained in this map entrySet() Returns an unmodifiable `Set` view of the mappings contained in this map.
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public T	Returns: the value to which the specified key is mapped, or `null` if this map contains no mapping for the key get(String the key whose associated value is to be returned key) Returns the value to which the specified key is mapped, or `null` if this option map contains no mapping for the key.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll toString wait wait wait

backingMap	back to summary
pack-priv final Map<String, T> backingMap

EMPTY	back to summary
private static final OptionMap<?> EMPTY

readonlyMap	back to summary
pack-priv final Map<String, T> readonlyMap

OptionMap	back to summary
pack-priv OptionMap(Map<String, T> map)

Method Detail

empty	back to summary
public static <T> OptionMap<T> empty() Returns an empty option map (immutable). Parameters <T> the class of the map values Returns:OptionMap<T> an empty option map Annotations @SuppressWarnings:unchecked Since 19.2

empty

back to summary

public static <T> OptionMap<T> empty()

Returns an empty option map (immutable).

Parameters

<T>: the class of the map values

Returns:OptionMap<T>

an empty option map

Annotations

@SuppressWarnings:unchecked

Since

19.2

entrySet back to summary

entrySet	back to summary
public Set<Map.Entry<String, T>> entrySet() Returns an unmodifiable `Set` view of the mappings contained in this map. Returns:Set<Map.Entry<String, T>> a set view of the mappings contained in this map Since 19.2

public Set<Map.Entry<String, T>> entrySet()

Returns an unmodifiable Set view of the mappings contained in this map.

Returns:Set<Map.Entry<String, T>>: a set view of the mappings contained in this map
Since: 19.2

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @SuppressWarnings:unchecked @Override Since 19.2

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@SuppressWarnings:unchecked
@Override

Since

19.2

get back to summary

get	back to summary
public T get(String key) Returns the value to which the specified key is mapped, or `null` if this option map contains no mapping for the key. Parameters key:String the key whose associated value is to be returned Returns:T the value to which the specified key is mapped, or `null` if this map contains no mapping for the key Since 19.2

public T get(String key)

Returns the value to which the specified key is mapped, or null if this option map contains no mapping for the key.

Parameters

key:String: the key whose associated value is to be returned

Returns:T

the value to which the specified key is mapped, or null if this map contains no mapping for the key

Since

19.2

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override Since 19.2

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

Since

19.2

public final Class OptionMap<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail