Package Torello.Java.Additional

Class Ret8<A1,B2,C3,D4,E5,F6,G7,H8>

java.lang.Object

Torello.Java.Additional.MultiType

Torello.Java.Additional.RetN

Torello.Java.Additional.Ret8<A1,B2,C3,D4,E5,F6,G7,H8>

Type Parameters:

A1 - The type of the first member-field ('a1').

B2 - The type of the second member-field ('b2').

C3 - The type of the third member-field ('c3').

D4 - The type of the fourth member-field ('d4').

E5 - The type of the fifth member-field ('e5').

F6 - The type of the sixth member-field ('f6').

G7 - The type of the seventh member-field ('g7').

H8 - The type of the last member-field ('h8').

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Ret8<A1,B2,C3,D4,E5,F6,G7,H8>
extends RetN
implements java.io.Serializable, java.lang.Cloneable

This simple generic-class allows a function to return eight objects as a result, instead of just one. This is not always so useful, and can make code confusing. However there are some instances where the only alternative would be to create an entirely new class/object, when only a single method result would use that object.

Field Name Change:
For the classes Ret6, Ret7 & Ret8 - the field names include a number as well (see a1, b2, c3 etc...). This is simply due to the fact that these Field-Names become progressively more difficult to read or even look at after the first four or five letters - 'a', 'b', 'c', 'd' and 'e'.

Immutable, Read-Only
Classes which inherit Ancestor-Class RetN will always contains fields declared using the 'final' modifier. These classes are, therefore, "Unmodifiable Tuples" - meaning their contents can never change once they have been instantiated.

Remember: The classes Ret8 and Tuple8 completely identical, with the sole difference being that Ret8 fields are all declared final, but the Tuple8 fields are not!

See Also:

Serialized Form

Hi-Lited Source-Code:

• View Here: Torello/Java/Additional/Ret8.java
• Open New Browser-Tab: Torello/Java/Additional/Ret8.java

File Size: 4,481 Bytes Line Count: 120 '\n' Characters Found

Field Summary

Serializable ID
Modifier and Type	Field
protected static long	serialVersionUID
Instance Fields
Modifier and Type	Field
A1	a1
B2	b2
C3	c3
D4	d4
E5	e5
F6	f6
G7	g7
H8	h8

Constructor Summary

Constructors

Constructor
Ret8(A1 a1, B2 b2, C3 c3, D4 d4, E5 e5, F6 f6, G7 g7, H8 h8)

Method Summary

Retrieve the Number of Fields in this Class
Modifier and Type	Method
int	n()
Retrieve a Field by Field-Number
Modifier and Type	Method
Object	get(int i)
Convert this instance to a Read-Write Tuple, of the same size
Modifier and Type	Method
Tuple8<A1, B2, C3, D4, E5, F6, G7, H8>	toModifiable()
Methods: interface java.lang.Cloneable
Modifier and Type	Method
Ret8<A1, B2, C3, D4, E5, F6, G7, H8>	clone()

Methods inherited from class Torello.Java.Additional.MultiType

asArray, equals, get, GET, hashCode, toString

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

🡇 ⇈ ⮫ 🗕 🗗 🗖

protected static final long serialVersionUID

This fulfils the SerialVersion UID requirement for all classes that implement Java's interface java.io.Serializable. Using the Serializable Implementation offered by java is very easy, and can make saving program state when debugging a lot easier. It can also be used in place of more complicated systems like "hibernate" to store data as well.

See Also:

Constant Field Values

Code:

Exact Field Declaration Expression:

 protected static final long serialVersionUID = 1;

a1

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final A1 a1

This holds a pointer the first response object.

Code:

Exact Field Declaration Expression:

 public final A1 a1;

b2

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final B2 b2

This holds a pointer to the second response object.

Code:

Exact Field Declaration Expression:

 public final B2 b2;

c3

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final C3 c3

This holds a pointer to the third response object.

Code:

Exact Field Declaration Expression:

 public final C3 c3;

d4

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final D4 d4

This holds a pointer to the fourth response object.

Code:

Exact Field Declaration Expression:

 public final D4 d4;

e5

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final E5 e5

This holds a pointer to the fifth response object.

Code:

Exact Field Declaration Expression:

 public final E5 e5;

f6

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final F6 f6

This holds a pointer to the sixth response object.

Code:

Exact Field Declaration Expression:

 public final F6 f6;

g7

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final G7 g7

This holds a pointer to the seventh response object.

Code:

Exact Field Declaration Expression:

 public final G7 g7;

h8

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final H8 h8

This holds a pointer to the seventh response object.

Code:

Exact Field Declaration Expression:

 public final H8 h8;

Constructor Detail

Ret8

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public Ret8(A1 a1,
            B2 b2,
            C3 c3,
            D4 d4,
            E5 e5,
            F6 f6,
            G7 g7,
            H8 h8)

Constructs this object

Method Detail

n

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public int n()

Returns '8', indicating how many fields are declared by this class.

Specified by:

n in class MultiType

Returns:

As an instance of Ret8, this method returns '8';

Code:

Exact Method Body:

 return 8;

clone

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public Ret8<A1,B2,C3,D4,E5,F6,G7,H8> clone()

Description copied from class: MultiType

Clones the contents of 'this' instance of.

Specified by:

clone in class MultiType

Returns:

A clone copy of 'this' object.

Code:

Exact Method Body:

 return new Ret8<>(this.a1, this.b2, this.c3, this.d4, this.e5, this.f6, this.g7, this.h8);

get

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public java.lang.Object get(int i)

This method will retreive the ith field of this instance. This can be useful when you wish to use the Ancestor / Parent classses: RetN or MultiType for handling 'this' instance.

As a reminder, the fields inside this class have all been declared public! Referencing this instance' fields, directly, will always work in place of calling any of the get(...) methods.

Type Casting:
This method can make for easier typing. When using either of the super-classes of this class - namely RetN or MultiType - you simply do not have to type (into your computer's keyboard) all of the Field Generic Types (the stuff between the '<' and '>' less-than & greater-than symbols).

However, anytime one of these ancestor classes are used instead of the actual Ret8 instance, you will have to use one of the provided 'get' methods to retrieve a field inside the Ret8 instance. This is because the parent-ancestor classes do not actually have any fields to retrieve.

There are three 'get' methods provided in Root-Ancestor Class MultiType. Each of these three 'getters' allows for casting (this) sub-class' returned fields in a slightly different way. When you aren't referencing the actual instance, itself, but rather one of the two Parent-Tuple Classes, you must use one of their getters, and you will have to cast the fields that you wish to use, eventually!

Example:

// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***
// No Cast Necessary
// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***

// This line makes for longer typing, but DOES NOT REQUIRE A CAST TO RETRIEVE FIELDS.
// Here the example Multi-Type Identifier is used: Ret8.

Ret8<String, Integer, Date, File, DotPair, HTMLNode, TagNode, TextNode> ref8 =
    some_function_returns_8();

String neededStrField = ref8.a1;


// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***
// Less Keyboard-Typing (Less Eyesores), but Requires a Cast
// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***

// If the Ret8 super-class RetN is used to reference this class data,
// YOU WILL NEED TO CAST THE FIELDS BEFORE YOU CAN THEM, AS IN THE EXAMPLES BELOW:

RetN refN = some_function_returns8();

// Version #1: (this method) - simple 'get'
@SuppressWarnings("unchecked")
String neededStrField = (String) refN.get(1);

// Version #2: The second Method-Parameter is a 'Class<T>' Type-Parameter
// Note, again, that passing a '1' to the first parameter retrieves Ret8.a1

String neededStrField = refN.get(1, String.class);

// Version #3: "GET" (in all caps) utilizes Java "Type-Inferencing" - the Return-Type
// is specified by the left side of the assignments statement.

String needesStrField = refN.GET(1);

Specified by:

get in class MultiType

Parameters:

i - This specifies which field of the instance is being requested.

IMPORTANT: Unlike a Java array, when a '1' is passed to this parameter, it is requesting the first field in this instance. Passing a value of '0' shall cause an IndexOutOfBoundsException throw.

Returns:

This returns the ith field of this class.

See Also:

MultiType.get(int, Class), MultiType.GET(int)

Code:

Exact Method Body:

 // Throws Exception if i not in [1..8]
 CHECK_GET(i);

 if (i <= 4) switch (i)
 {
     case 1:     return a1;
     case 2:     return b2;
     case 3:     return c3;
     default:    return d4;
 }

 else switch (i)
 {
     case 5:     return e5;
     case 6:     return f6;
     case 7:     return g7;
     default:    return h8;
 }

toModifiable

🡅 ⇈ ⮫ 🗕 🗗 🗖

public Tuple8<A1,B2,C3,D4,E5,F6,G7,H8> toModifiable()

Description copied from class: RetN

Converts 'this' Read-Only RetN instance into a Read-Write TupleN.

Specified by:

toModifiable in class RetN

Returns:

A TupleN of the same size, which is a modifiable type whose fields are not decorated with the 'final' modifier - as the fields in this class are.

Code:

Exact Method Body:

 return new Tuple8<>
     (this.a1, this.b2, this.c3, this.d4, this.e5, this.f6, this.g7, this.h8);