js.lang

Class Pair

java.lang.Object

js.lang.Pair

public final class Pair
extends Object

Immutable pair of string values.

Version:

final

Author:

Iulian Rotaru

Field Summary

Fields

Modifier and Type	Field and Description
private String	first First value of this pair.
private int	hash Cache hash code for this immutable instance.
private String	second The second value of this pair.

Constructor Summary

Constructors

Constructor and Description
Pair(String first, String second) Construct a pair instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Equality test operator.
String	first() Get first value of this pair.
int	hashCode() Get instance hash code.
String	key() Semantic alias for first(), when pair is used in a map context.
String	second() Get the second value of this pair.
String	toString()
String	value() Semantic alias for second(), when pair is used in a map context.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

first

private final String first

First value of this pair.

second

private final String second

The second value of this pair.

hash

private int hash

Cache hash code for this immutable instance.

Constructor Detail

Pair

public Pair(String first,
            String second)

Construct a pair instance.

Parameters:

first - first pair value,

second - pair value.

Method Detail

first

public String first()

Get first value of this pair.

Returns:

this pair first value.

second

public String second()

Get the second value of this pair.

Returns:

this pair second value.

key

public String key()

Semantic alias for first(), when pair is used in a map context.

Returns:

this pair first value considered a key.

value

public String value()

Semantic alias for second(), when pair is used in a map context.

Returns:

this pair second value.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Get instance hash code.

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Equality test operator.

Overrides:

equals in class Object

Parameters:

obj - instance to compare with.