JavaTuples - Quartet Class

Advertisements

Previous Page
Next Page  

Introduction

The org.javatuples.Quartet class represents a Tuple with four elements.

Class Declaration

Following is the declaration for org.javatuples.Quartet class −

public final class Quartet<A, B, C, D>
   extends Tuple
      implements IValue0<A>, IValue1<B>, IValue2<C>, IValue3<D>

Class Constructor

Sr.No. Constructor & Description
1

Quartet(A value0, B value1, C value2, D value3)

This creates a Quartet Tuple.

Class Methods

Similarly setAt1() upto setAt3() set the value at index 1, and so on.

Sr.No. Method & Description
1

Quintet add(Unit tuple)

This method returns a Quintet tuple.

Similarly other methods to add tuples are available e.g. add(Pair tuple) returns Sextet and upto add(Sextet tuple) returns Decade tuple.
2

Quintet add(X0 value)

This method add a value to the tuple and returns a Quintet tuple.

Similarly other methods to add values are available e.g. add(X0 value0, X1 value1) returns Sextet and so on upto add() with six parameters.
3

Quintet addAt0(Unit value)

This method add a Unit tuple at index 0 and returns a Quintet tuple.

Similarly other methods to add tuples are available e.g. addAt0(Pair value) returns Sextet and so on upto addAt0(Sextet). Other similar method are addAt1(Unit value) which add a unit at index0 and have similar methods upto addAt2(Sextet).
4

Quintet addAt0(X0 value)

This method add a value at index 0 and returns a Quintet tuple.

Similarly other methods to add values are available e.g. addAt0(X0 value0, X1 value1) returns Sextet and so on upto addAt0() with six parameters. Other similar method are addAt1(X0 value) which add a value at index0 and have similar methods upto addAt2() with six parameters.
5

static <X> Quartet<X,X,X,X> fromArray(X[] array)

Create tuple from array.
6

static <X> Quartet<X,X,X,X> fromCollection(Collection<X> collection)

Create tuple from collection.
7

static <X> Quartet<X,X,X,X> fromIterable(Iterable<X> iterable)

Create tuple from iterable.
8

static <X> Quartet<X,X,X,X> fromIterable(Iterable<X> iterable, int index)

Create tuple from iterable, starting from the specified index.
9

int getSize()

Return the size of the tuple.
10

A getValue0()

Returns the value of the tuple at index 0.

Similarly getValue1() upto getValue3() returns the value at index 1 and so on.
11

Triplet<B,C,D> removeFrom0()

Return the tuple after removing value of the tuple at index 0.

Similarly removeFrom1() upto removeFrom3() returns the tuple after removing value of the tuple at index 1 and so on.
12

<X> Quartet<X,B,C,D> setAt0(X value)

Set the value of the tuple at index 0.
13

static <A> Quartet<A,B,C,D> with(A value0, B value1, C value2, D value3)

Create the tuple using given value.

Methods inherite

This class inherits methods from the following classes −

  • org.javatuples.Tuple

  • Object

Example

Let's see Quartet Class in action. Here we'll see how to use various methods.

Create a java class file named TupleTester in C:\>JavaTuples.

File: TupleTester.java

package com.howcodex;
import java.util.ArrayList;
import java.util.List;
import org.javatuples.Quartet;
import org.javatuples.Quintet;
import org.javatuples.Triplet;

public class TupleTester {
   public static void main(String args[]){
      Quartet<Integer, Integer, Integer, Integer> quartet = Quartet.with(
         5, 6, 7,8
      );
      System.out.println(quartet);
      boolean isPresent = quartet.contains(5);
      System.out.println("5 is present: " + isPresent);
      List<Integer> list = new ArrayList<>();
      list.add(1);
      list.add(2);
      list.add(3);
      list.add(4);
      Quintet<Integer, Integer, Integer, Integer, String> quintet = quartet.add("Test");
      System.out.println(quintet);
      Integer value = quartet.getValue0();
      System.out.println(value);
      Triplet<Integer, Integer, Integer> triplet = quartet.removeFrom0();
      System.out.println(triplet);
      Quartet<Integer, Integer, Integer, Integer> quartet1 = Quartet.fromCollection(list);   
      System.out.println(quartet1);
   }
}

Verify the result

Compile the classes using javac compiler as follows −

C:\JavaTuples>javac -cp javatuples-1.2.jar ./com/howcodex/TupleTester.java

Now run the TupleTester to see the result −

C:\JavaTuples>java  -cp .;javatuples-1.2.jar com.howcodex.TupleTester

Output

Verify the Output

[5, 6, 7, 8]
5 is present: true
[5, 6, 7, 8, Test]
5
[6, 7, 8]
[1, 2, 3, 4]
Advertisements