L
- the left element typeM
- the middle element typeR
- the right element typepublic abstract class Triple<L,M,R> extends Object implements Comparable<Triple<L,M,R>>, Serializable
A triple consisting of three elements.
This class is an abstract implementation defining the basic API. It refers to the elements as 'left', 'middle' and 'right'.
Subclass implementations may be mutable or immutable. However, there is no restriction on the type of the stored objects that may be stored. If mutable objects are stored in the triple, then the triple itself effectively becomes mutable.
Constructor and Description |
---|
Triple() |
Modifier and Type | Method and Description |
---|---|
int |
compareTo(Triple<L,M,R> other)
Compares the triple based on the left element, followed by the middle element,
finally the right element.
|
boolean |
equals(Object obj)
Compares this triple to another based on the three elements.
|
abstract L |
getLeft()
Gets the left element from this triple.
|
abstract M |
getMiddle()
Gets the middle element from this triple.
|
abstract R |
getRight()
Gets the right element from this triple.
|
int |
hashCode()
Returns a suitable hash code.
|
static <L,M,R> Triple<L,M,R> |
of(L left,
M middle,
R right)
Obtains an immutable triple of from three objects inferring the generic types.
|
String |
toString()
Returns a String representation of this triple using the format
($left,$middle,$right) . |
String |
toString(String format)
Formats the receiver using the given format.
|
public Triple()
public static <L,M,R> Triple<L,M,R> of(L left, M middle, R right)
Obtains an immutable triple of from three objects inferring the generic types.
This factory allows the triple to be created using inference to obtain the generic types.
L
- the left element typeM
- the middle element typeR
- the right element typeleft
- the left element, may be nullmiddle
- the middle element, may be nullright
- the right element, may be nullpublic abstract L getLeft()
Gets the left element from this triple.
public abstract M getMiddle()
Gets the middle element from this triple.
public abstract R getRight()
Gets the right element from this triple.
public int compareTo(Triple<L,M,R> other)
Compares the triple based on the left element, followed by the middle element,
finally the right element.
The types must be Comparable
.
public boolean equals(Object obj)
Compares this triple to another based on the three elements.
public int hashCode()
Returns a suitable hash code.
public String toString()
Returns a String representation of this triple using the format ($left,$middle,$right)
.
public String toString(String format)
Formats the receiver using the given format.
This uses Formattable
to perform the formatting. Three variables may
be used to embed the left and right elements. Use %1$s
for the left
element, %2$s
for the middle and %3$s
for the right element.
The default format used by toString()
is (%1$s,%2$s,%3$s)
.
format
- the format string, optionally containing %1$s
, %2$s
and %3$s
, not nullCopyright © 2001–2015 The Apache Software Foundation. All rights reserved.