Graal Sdk 23.1.1 · org.graalvm.collections.Pair · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private static final Pair<Object, Object>	EMPTY
private final L	left
private final R	right

Access	Constructor and Description
private	Pair(L left, R right)

Method Summary

Modifier and Type	Method and Description
public static <L, R> Pair<L, R>	Returns: the constructed pair or an empty pair if both inputs are null. create(L left, R right) Constructs a pair with its left value being `left`, and its right value being `right`, or returns an empty pair if both inputs are null.
public static <L, R> Pair<L, R>	Returns: the constructed pair or an empty pair if `left` is null. createLeft(L left) Constructs a pair with its left value being `left`, or returns an empty pair if `left` is null.
public static <L, R> Pair<L, R>	Returns: the constructed pair or an empty pair if `right` is null. createRight(R right) Constructs a pair with its right value being `right`, or returns an empty pair if `right` is null.
public static <L, R> Pair<L, R>	empty() Returns an empty pair.
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 L	getLeft() Returns the left value of this pair.
public R	getRight() Returns the right value of this pair.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

EMPTY	back to summary
private static final Pair<Object, Object> EMPTY

left	back to summary
private final L left

right	back to summary
private final R right

Pair	back to summary
private Pair(L left, R right)

Method Detail

create back to summary

create	back to summary
public static <L, R> Pair<L, R> create(L left, R right) Constructs a pair with its left value being `left`, and its right value being `right`, or returns an empty pair if both inputs are null. Returns:Pair<L, R> the constructed pair or an empty pair if both inputs are null. Since 19.0

public static <L, R> Pair<L, R> create(L left, R right)

Constructs a pair with its left value being left, and its right value being right, or returns an empty pair if both inputs are null.

Returns:Pair<L, R>: the constructed pair or an empty pair if both inputs are null.
Since: 19.0

createLeft back to summary

createLeft	back to summary
public static <L, R> Pair<L, R> createLeft(L left) Constructs a pair with its left value being `left`, or returns an empty pair if `left` is null. Returns:Pair<L, R> the constructed pair or an empty pair if `left` is null. Since 19.0

public static <L, R> Pair<L, R> createLeft(L left)

Constructs a pair with its left value being left, or returns an empty pair if left is null.

Returns:Pair<L, R>: the constructed pair or an empty pair if left is null.
Since: 19.0

createRight back to summary

createRight	back to summary
public static <L, R> Pair<L, R> createRight(R right) Constructs a pair with its right value being `right`, or returns an empty pair if `right` is null. Returns:Pair<L, R> the constructed pair or an empty pair if `right` is null. Since 19.0

public static <L, R> Pair<L, R> createRight(R right)

Constructs a pair with its right value being right, or returns an empty pair if right is null.

Returns:Pair<L, R>: the constructed pair or an empty pair if right is null.
Since: 19.0

empty	back to summary
public static <L, R> Pair<L, R> empty() Returns an empty pair. Annotations @SuppressWarnings:unchecked Since 19.0

empty

back to summary

public static <L, R> Pair<L, R> empty()

Returns an empty pair.

Annotations

@SuppressWarnings:unchecked

Since

19.0

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.0

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.0

getLeft	back to summary
public L getLeft() Returns the left value of this pair. Since 19.0

getLeft

back to summary

public L getLeft()

Returns the left value of this pair.

Since: 19.0

getRight	back to summary
public R getRight() Returns the right value of this pair. Since 19.0

getRight

back to summary

public R getRight()

Returns the right value of this pair.

Since: 19.0

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 the 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.0

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the 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.0

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object Annotations @Override Since 19.0

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations

@Override

Since

19.0

public final Class Pair<L, R>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail