de.vandermeer.skb.interfaces

Interface SimplePair<LHS,RHS>

public interface SimplePair<LHS,RHS>

A pair of things, with a left and a right hand side (or left and right).

Since:

v0.0.1

Version:

v0.0.2 build 170502 (02-May-17) for Java 1.8

Author:

Sven van der Meer <vdmeer.sven@mykolab.com>

Method Summary

Modifier and Type	Method and Description
static <LHS,RHS> SimplePair<LHS,RHS>	create(LHS lhs, RHS rhs) Returns a new Pair of given type with default description.
static <LHS,RHS> SimplePair<LHS,RHS>	create(LHS lhs, RHS rhs, String description) Creates a new Pair of given type with given description.
String	getDescription() Returns the description of an object.
LHS	left() Returns the value of the left hand side of the pair.
LHS	lhs() Returns the value of the left hand side of the pair.
RHS	rhs() Returns the value of the right hand side of the pair.
RHS	right() Returns the value of the right hand side of the pair.

Method Detail

rhs

RHS rhs()

Returns the value of the right hand side of the pair.

Returns:

right hand side value

right

RHS right()

Returns the value of the right hand side of the pair.

Returns:

right hand side value

lhs

LHS lhs()

Returns the value of the left hand side of the pair.

Returns:

left had side value

left

LHS left()

Returns the value of the left hand side of the pair.

Returns:

left had side value

getDescription

String getDescription()

Returns the description of an object.

Returns:

description

create

static <LHS,RHS> SimplePair<LHS,RHS> create(LHS lhs,
                                            RHS rhs)

Returns a new Pair of given type with default description.

Type Parameters:

LHS - type for left hand site

RHS - type for right hand site

Parameters:

rhs - right hand side of the pair

lhs - left hand side of the pair

Returns:

new pair

create

static <LHS,RHS> SimplePair<LHS,RHS> create(LHS lhs,
                                            RHS rhs,
                                            String description)

Creates a new Pair of given type with given description.

Type Parameters:

LHS - type for left hand site

RHS - type for right hand site

Parameters:

rhs - right hand side of the pair

lhs - left hand side of the pair

description - description of the pair

Returns:

new pair