Eclipse Xtext 2.39.0 · org.eclipse.xtext.xbase.lib.Pair

Modifier and Type	Field and Description
private final K	k
private static final long	serialVersionUID
private final V	v

Access	Constructor and Description
public	Pair(K the key. May be `null`. k, V the value. May be `null`. v) Creates a new instance with the given key and value.

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public K	Returns: the key. getKey() Returns the key.
public V	Returns: the value. getValue() Returns the value.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public static <K, V> Pair<K, V>	Returns: a newly created pair. Never `null`. of(K the key. May be `null`. k, V the value. May be `null`. v) Creates a new instance with the given key and value.
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

k	back to summary
private final K k

serialVersionUID	back to summary
private static final long serialVersionUID

v	back to summary
private final V v

Pair	back to summary
public Pair(K k, V v) Creates a new instance with the given key and value. Parameters k:K the key. May be `null`. v:V the value. May be `null`. Annotations @Pure

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object o) 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. Annotations @Override

public boolean equals(Object o)

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.

Annotations

@Override

getKey	back to summary
public K getKey() Returns the key. Returns:K the key. Annotations @Pure

getKey

back to summary

public K getKey()

Returns the key.

Returns:K

the key.

Annotations

@Pure

getValue	back to summary
public V getValue() Returns the value. Returns:V the value. Annotations @Pure

getValue

back to summary

public V getValue()

Returns the value.

Returns:V

the value.

Annotations

@Pure

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. Annotations @Override

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.

Annotations

@Override

of back to summary

of	back to summary
public static <K, V> Pair<K, V> of(K k, V v) Creates a new instance with the given key and value. May be used instead of the constructor for convenience reasons. Parameters k:K the key. May be `null`. v:V the value. May be `null`. Returns:Pair<K, V> a newly created pair. Never `null`. Annotations @Pure Since 2.3

public static <K, V> Pair<K, V> of(K k, V v)

Creates a new instance with the given key and value. May be used instead of the constructor for convenience reasons.

Parameters

k:K: the key. May be null.
v:V: the value. May be null.

Returns:Pair<K, V>

a newly created pair. Never null.

Annotations

@Pure

Since

2.3

toString back to summary

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. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

public final Class Pair<K, V>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail