info.javelot.functionalj.tuple
Class Quadruple

java.lang.Object
  extended byinfo.javelot.functionalj.tuple.Pair
      extended byinfo.javelot.functionalj.tuple.Triple
          extended byinfo.javelot.functionalj.tuple.Quadruple
All Implemented Interfaces:
Comparable, Serializable

public class Quadruple
extends Triple

Used to create a tuple of four objects. Tuples can be used anywhere there is a need to group objects together, and Quadruples are used by the Tuples.zip(Collection, Collection, Collection, Collection) method.

Author:
Copyright © 2006 Frederic Daoud
See Also:
Serialized Form

Field Summary
static Function1 fourth
          Function that returns the fourth element of the tuple.
static Function4 quadruple
          Function that creates a Quadruple.
 
Fields inherited from class info.javelot.functionalj.tuple.Triple
third, triple
 
Fields inherited from class info.javelot.functionalj.tuple.Pair
first, pair, second
 
Constructor Summary
Quadruple(Object p_first, Object p_second, Object p_third, Object p_fourth)
          Creates a tuple of the four given objects.
 
Method Summary
 int compareTo(Object p_object)
          Sort tuples according to the objects that they contain.
 boolean equals(Object p_object)
          Determines if the given object is equal to this object, by comparing the four objects of each quadruple.
 Object getFourth()
          Returns the fourth object of the tuple.
protected  List getStrings()
          Returns a list of the String representations of the objects of the tuple.
 int hashCode()
          Returns the hash code associated with this object.
 void setFourth(Object p_fourth)
          Sets the fourth object of the tuple.
 
Methods inherited from class info.javelot.functionalj.tuple.Triple
getThird, setThird
 
Methods inherited from class info.javelot.functionalj.tuple.Pair
getFirst, getSecond, setFirst, setSecond, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

quadruple

public static final Function4 quadruple
Function that creates a Quadruple.


fourth

public static final Function1 fourth
Function that returns the fourth element of the tuple.

Constructor Detail

Quadruple

public Quadruple(Object p_first,
                 Object p_second,
                 Object p_third,
                 Object p_fourth)
Creates a tuple of the four given objects.

Parameters:
p_fourth - the fourth object of the quadruple. A null value is accepted. The first three parameters are those accepted by Triple.Triple(Object, Object, Object).
See Also:
Triple.Triple(Object, Object, Object)
Method Detail

getFourth

public Object getFourth()
Returns the fourth object of the tuple.

Returns:
the fourth object of the tuple, which may be null.

setFourth

public void setFourth(Object p_fourth)
Sets the fourth object of the tuple.

Parameters:
p_fourth - the fourth object of the tuple.

hashCode

public int hashCode()
Returns the hash code associated with this object.

Overrides:
hashCode in class Triple
Returns:
the hash code associated with this object.
See Also:
Pair.hashCode()

equals

public boolean equals(Object p_object)
Determines if the given object is equal to this object, by comparing the four objects of each quadruple.

Overrides:
equals in class Triple
See Also:
Pair.equals(Object)

compareTo

public int compareTo(Object p_object)
Description copied from class: Pair
Sort tuples according to the objects that they contain. If the contained in the tuples do not implement the Comparable interface, they are left unsorted.

Specified by:
compareTo in interface Comparable
Overrides:
compareTo in class Triple

getStrings

protected List getStrings()
Returns a list of the String representations of the objects of the tuple. Here the fourth object of the tuple is added to the list.

Overrides:
getStrings in class Triple
Returns:
a list of the String representations of the objects of the tuple.
See Also:
Pair.toString()