org.projectfloodlight.openflow.types

Interface HashValue.Builder<H>

Type Parameters:

H - - the hashvalue

Enclosing interface:

HashValue<H extends HashValue<H>>

public static interface HashValue.Builder<H>

a mutator for HashValues. Allows perfomring a series of operations on a hashv value without the associated cost of object reallocation.

Author:

Andreas Wundsam <andreas.wundsam@bigswitch.com>

Method Summary

Modifier and Type	Method and Description
HashValue.Builder<H>	add(H other) perform an arithmetic addition of this value and other.
HashValue.Builder<H>	and(H other) and the value stored in this mutator with another value value of the same type
H	build() construct an immutable value from the value defined in the builder
HashValue.Builder<H>	invert() bitwise invert the value stored in this mutator
HashValue.Builder<H>	or(H other) or the value stored in this mutator with another value value of the same type
HashValue.Builder<H>	subtract(H other) arithmetically substract the given 'other' value from the value stored in this mutator.
HashValue.Builder<H>	xor(H other) xor the value stored in this mutator with another value value of the same type

Method Detail

add

HashValue.Builder<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 mutator containing this + other

subtract

HashValue.Builder<H> subtract(H other)

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

Parameters:

other - the other value to subtract from this

Returns:

this mutator containing this - other

invert

HashValue.Builder<H> invert()

bitwise invert the value stored in this mutator

Returns:

this mutator containing ~this

or

HashValue.Builder<H> or(H other)

or the value stored in this mutator with another value value of the same type

Parameters:

other - the other value to bitwise or with this

Returns:

this mutator containing this | other

and

HashValue.Builder<H> and(H other)

and the value stored in this mutator with another value value of the same type

Parameters:

other - the other value to bitwise and with this

Returns:

this mutator containing this & other

xor

HashValue.Builder<H> xor(H other)

xor the value stored in this mutator with another value value of the same type

Parameters:

other - the other value to bitwise exclusive or with this

Returns:

this mutator containing this XOR other

build

H build()

construct an immutable value from the value defined in the builder

Returns:

the hash value