org.projectfloodlight.openflow.types

Interface HashValue<H extends HashValue<H>>

All Known Implementing Classes:

U128, U64

@Immutable
public interface HashValue<H extends HashValue<H>>

a hash value that supports bit-wise combinations, mainly to calculate hash values for reconciliation operations.

Author:

Andreas Wundsam <andreas.wundsam@bigswitch.com>

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	HashValue.Builder<H> a mutator for HashValues.

Method Summary

Methods

Modifier and Type	Method and Description
H	add(H other) perform an arithmetic addition of this value and other.
H	and(H other) and this value with another value value of the same type
HashValue.Builder<H>	builder() create and return a builder
H	inverse()
H	or(H other) or this value with another value value of the same type
int	prefixBits(int numBits) return the "numBits" highest-order bits of the hash.
H	subtract(H other) arithmetically substract the given 'other' value from this value.
H	xor(H other) xor this value with another value value of the same type

Method Detail

prefixBits

int prefixBits(int numBits)

return the "numBits" highest-order bits of the hash.

Parameters:

numBits - number of higest-order bits to return [0-32].

Returns:

a numberic value of the 0-32 highest-order bits.

add

H add(H other)

perform an arithmetic addition of this value and other. Wraps around on overflow of the defined word size.

Parameters:

other - the other value to add to this

Returns:

this + other

subtract

H subtract(H other)

arithmetically substract the given 'other' value from this value. around on overflow.

Parameters:

other - the other value to subtract from this

Returns:

this - other

inverse

H inverse()

Returns:

the bitwise inverse of this value

or

H or(H other)

or this value with another value value of the same type

Parameters:

other - the other value to bitwise or with this

Returns:

this | other

and

H and(H other)

and this value with another value value of the same type

Parameters:

other - the other value to bitwise and with this

Returns:

this & other

xor

H xor(H other)

xor this value with another value value of the same type

Parameters:

other - the other value to bitwise xor with this

Returns:

this XOR other

builder

HashValue.Builder<H> builder()

create and return a builder

Returns:

builder