de.caff.generics

Class BytePair

java.lang.Object

de.caff.generics.BytePair

All Implemented Interfaces:

ByteIndexable, PrimitiveByteIterable, Sizeable, java.io.Serializable, java.lang.Iterable<java.lang.Byte>

public final class BytePair
extends java.lang.Object
implements java.io.Serializable, ByteIndexable

A pair of primitive byte values.

This is similar to Pair, but for raw byte values. As these values are defined final, this class is also immutable.

Since:

December 04, 2020

Author:

Rammi

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface de.caff.generics.ByteIndexable

ByteIndexable.Base

Field Summary

Fields

Modifier and Type	Field and Description
byte	first The first value of this pair.
byte	second The second value of this pair.

Fields inherited from interface de.caff.generics.ByteIndexable

EMPTY, LOWERCASE_2DIGIT_HEXCODES, SINGLE_0, UPPERCASE_2DIGIT_HEXCODES

Fields inherited from interface de.caff.generics.PrimitiveByteIterable

EMPTY_BYTE_ITERATOR

Fields inherited from interface de.caff.generics.Sizeable

NULL

Constructor Summary

Constructors

Constructor and Description
BytePair(byte first, byte second) Constructor.

Method Summary

Modifier and Type	Method and Description
<T> T	applyAsBytes(ByteFunction2<T> function) Apply a 2-byte function on this pair.
boolean	equals(java.lang.Object o)
byte	get(int index) Get the element at the given index.
int	hashCode()
byte	operate(ByteOperator2 operator) Call an 2-byte operator on this pair.
int	size() Get the size.
BytePair	swapped() Get this pair with swapped values.
boolean	test(BytePredicate2 predicate) Call a 2-byte predicate on this pair.
IntPair	toIntPair() Convert this pair of bytes into a pair of ints.
java.lang.String	toString()
Tuple2<java.lang.Byte,java.lang.Byte>	toTuple() Convert this into a tuple.
IntPair	toUnsignedIntPair() Convert this pair of bytes into a pair of ints assuming unsigned values.
BytePair	withFirst(byte first) Get this pair with a different first value.
BytePair	withSecond(byte second) Get this pair with a different first value.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.caff.generics.ByteIndexable

addAllTo, addToArray, addToArray, addToArray, addToArray, asBase, asCollection, asIndexable, asIntIndexable, asList, asUnsignedIndexable, binarySearch, binarySearch, byteIterator, byteIterator, bytesFromHexString, compare, compareUnsigned, copyTo, copyTo, emptyIndexable, equal, equal, firstMatch, foldLeft, fromHexString, frozen, getMod, gyt, hash, headSet, indexes, init, initByIndex, intIndexes, intIterator, isEmpty, isOrdered, isOrdered, isStrictlyOrdered, isStrictlyOrdered, iterator, lastMatch, listIterator, nextMatch, ordered, previousMatch, reverse, rotated, singleton, subSet, sybSet, tailSet, toArray, toByteArray, toHexString, toHexString, toIntArray, toList, toString, view, viewArray, viewArray, viewArray, viewAsBoolean, viewAsDouble, viewAsFloat, viewAsInt, viewAsLong, viewAsShort, viewAsUnsignedInt, viewAsUnsignedLong, viewAsUnsignedShort, viewByIndex, viewIndexable, viewIndexable, viewIndexable, viewList, viewList, viewList, viewNumberArray, viewOp, withAppendedValue, withCachedHash, withExchangedValueAt, withInsertedValueAt, withRemovedValueAt, withSwappedValuesAt

Methods inherited from interface de.caff.generics.PrimitiveByteIterable

asIntIterable, asLongIterable, asShortIterable, asUnsignedIntIterable, asUnsignedLongIterable, containsByte, forEachByte, forEachByteFragile

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

first

public final byte first

The first value of this pair.

second

public final byte second

The second value of this pair.

Constructor Detail

BytePair

public BytePair(byte first,
                byte second)

Constructor.

Parameters:

first - first value of pair

second - second value of pair

Method Detail

toIntPair

@NotNull
public IntPair toIntPair()

Convert this pair of bytes into a pair of ints.

Returns:

int pair with same values

toUnsignedIntPair

@NotNull
public IntPair toUnsignedIntPair()

Convert this pair of bytes into a pair of ints assuming unsigned values.

Returns:

int pair with the values of this pair assumed unsigned

withFirst

@NotNull
public BytePair withFirst(byte first)

Get this pair with a different first value.

Parameters:

first - new first value

Returns:

pair with the given first value, and the second value of this pair

withSecond

@NotNull
public BytePair withSecond(byte second)

Get this pair with a different first value.

Parameters:

second - new second value

Returns:

pair with the first value of this pair, and the given second value

swapped

@NotNull
public BytePair swapped()

Get this pair with swapped values.

Returns:

pair with swapped first and second values

size

public int size()

Description copied from interface: Sizeable

Get the size. Size is never negative.

Specified by:

size in interface Sizeable

Returns:

the size of this object, usually the number of contained elements, must not be negative

get

public byte get(int index)

Description copied from interface: ByteIndexable

Get the element at the given index.

Specified by:

get in interface ByteIndexable

Parameters:

index - index between 0 and size() - 1

Returns:

element at the given index

applyAsBytes

public <T> T applyAsBytes(@NotNull
                          ByteFunction2<T> function)

Apply a 2-byte function on this pair.

Type Parameters:

T - output type

Parameters:

function - function to apply, first becomes its first, second its second argument

Returns:

result of applying the function

operate

public byte operate(@NotNull
                    ByteOperator2 operator)

Call an 2-byte operator on this pair.

Parameters:

operator - operator to apply, first becomes its first, second its second argument

Returns:

result of applying the operator

test

public boolean test(@NotNull
                    BytePredicate2 predicate)

Call a 2-byte predicate on this pair.

Parameters:

predicate - predicate to apply, first becomes its first, second its second argument

Returns:

result of testing this pair

toTuple

@NotNull
public Tuple2<java.lang.Byte,java.lang.Byte> toTuple()

Convert this into a tuple.

Returns:

tuple created from this pair

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

@NotNull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object