org.jscsi.utils

Class SerialArithmeticNumber

java.lang.Object

org.jscsi.utils.SerialArithmeticNumber

All Implemented Interfaces:

Comparable<Integer>

public final class SerialArithmeticNumber
extends Object
implements Comparable<Integer>

SerialArithmeticNumber

This class encapsulate the behavior of how to compare and increment a number in Serial Number Arithmetic, which is defined in [RFC1982].

Author:

Volker Wildi, University of Konstanz

Constructor Summary

Constructors

Constructor and Description
SerialArithmeticNumber() Default constructor to create a new, empty SerialArithmeticNumber instance, which is initialized to 0.
SerialArithmeticNumber(int startValue) Constructor to create a new SerialArithmeticNumber instance, which is initialized to startValue.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(int anotherSerialNumber) Same as the compareTo method only with the exception of another parameter type.
int	compareTo(Integer anotherSerialNumber)
int	getValue() Returns the current value of this SerialArithmeticNumber instance.
void	increment() Increments the value of this SerialArithmeticNumber instance.
void	setValue(int newValue) Updates the value of this SerialArithmeticNumber instance to the given one.

Methods inherited from class java.lang.Object

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

Constructor Detail

SerialArithmeticNumber

public SerialArithmeticNumber()

Default constructor to create a new, empty SerialArithmeticNumber instance, which is initialized to 0.

SerialArithmeticNumber

public SerialArithmeticNumber(int startValue)

Constructor to create a new SerialArithmeticNumber instance, which is initialized to startValue.

Parameters:

startValue - The start value.

Method Detail

compareTo

public final int compareTo(int anotherSerialNumber)

Same as the compareTo method only with the exception of another parameter type.

Parameters:

anotherSerialNumber - The number to compare with.

Returns:

a negative integer, zero, or a positive integer as this SerialArithmeticNumber is less than, equal to, or greater than the given number.

compareTo

public final int compareTo(Integer anotherSerialNumber)

Specified by:

compareTo in interface Comparable<Integer>

getValue

public final int getValue()

Returns the current value of this SerialArithmeticNumber instance.

Returns:

The current value of this SerialArithmeticNumber instance.

increment

public final void increment()

Increments the value of this SerialArithmeticNumber instance.

setValue

public final void setValue(int newValue)

Updates the value of this SerialArithmeticNumber instance to the given one.

Parameters:

newValue - The new value.