Package com.github.fracpete.javautils

Class Struct

java.lang.Object

com.github.fracpete.javautils.Struct

public class Struct
extends java.lang.Object

For wrapping multiple objects in container objects.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

StructExamples

Constructor Summary

Constructors

Constructor	Description
Struct()

Method Summary

Modifier and Type	Method	Description
static <T1,T2> java.lang.Iterable<MapStruct<T1,T2>>	pairs(java.util.Map<T1,T2> map)	Wraps the key/value pairs of a map in a struct container.
static <T1,T2> Struct2<T1,T2>	struct(T1 value1, T2 value2)	Wraps two elements in struct container.
static <T1,T2,T3> Struct3<T1,T2,T3>	struct(T1 value1, T2 value2, T3 value3)	Wraps three elements in struct container.
static <T1,T2,T3,T4> Struct4<T1,T2,T3,T4>	struct(T1 value1, T2 value2, T3 value3, T4 value4)	Wraps four elements in struct container.
static <T1,T2,T3,T4,T5> Struct5<T1,T2,T3,T4,T5>	struct(T1 value1, T2 value2, T3 value3, T4 value4, T5 value5)	Wraps five elements in struct container.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Struct

public Struct()

Method Detail

struct

public static <T1,T2> Struct2<T1,T2> struct(T1 value1,
                                            T2 value2)

Wraps two elements in struct container.

Type Parameters:

T1 - the first type

T2 - the second type

Parameters:

value1 - the first value

value2 - the second value

Returns:

the generated container

struct

public static <T1,T2,T3> Struct3<T1,T2,T3> struct(T1 value1,
                                                  T2 value2,
                                                  T3 value3)

Wraps three elements in struct container.

Type Parameters:

T1 - the first type

T2 - the second type

T3 - the third type

Parameters:

value1 - the first value

value2 - the second value

value3 - the third value

Returns:

the generated container

struct

public static <T1,T2,T3,T4> Struct4<T1,T2,T3,T4> struct(T1 value1,
                                                        T2 value2,
                                                        T3 value3,
                                                        T4 value4)

Wraps four elements in struct container.

Type Parameters:

T1 - the first type

T2 - the second type

T3 - the third type

T4 - the fourth type

Parameters:

value1 - the first value

value2 - the second value

value3 - the third value

value4 - the fourth value

Returns:

the generated container

struct

public static <T1,T2,T3,T4,T5> Struct5<T1,T2,T3,T4,T5> struct(T1 value1,
                                                              T2 value2,
                                                              T3 value3,
                                                              T4 value4,
                                                              T5 value5)

Wraps five elements in struct container.

Type Parameters:

T1 - the first type

T2 - the second type

T3 - the third type

T4 - the fourth type

T5 - the fifth type

Parameters:

value1 - the first value

value2 - the second value

value3 - the third value

value4 - the fourth value

value5 - the fifth value

Returns:

the generated container

pairs

public static <T1,T2> java.lang.Iterable<MapStruct<T1,T2>> pairs(java.util.Map<T1,T2> map)

Wraps the key/value pairs of a map in a struct container.

Type Parameters:

T1 - the key type

T2 - the value type

Parameters:

map - the map

Returns:

the generated container