info.bioinfweb.commons.collections.bitstorage.exception

Class BitIndexOutOfBoundException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

java.lang.IndexOutOfBoundsException

info.bioinfweb.commons.collections.bitstorage.exception.BitIndexOutOfBoundException

All Implemented Interfaces:

BitStorageException, java.io.Serializable

public class BitIndexOutOfBoundException
extends java.lang.IndexOutOfBoundsException
implements BitStorageException

Exception that is thrown if a bit index of a BitField is used which lies outside the current size of that field.

Author:

Ben Stöver

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BitIndexOutOfBoundException(java.lang.String message, BitField source, long index) Creates a new instance of this class.

Method Summary

Modifier and Type	Method and Description
long	getIndex() Returns the invalid bit index.
BitField	getSource() Returns the bit field where the exception occurred.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

BitIndexOutOfBoundException

public BitIndexOutOfBoundException(java.lang.String message,
                                   BitField source,
                                   long index)

Creates a new instance of this class.

Parameters:

message - the error message

source - the bit field throwing this exception

index - the invalid bit index

Method Detail

getSource

public BitField getSource()

Description copied from interface: BitStorageException

Returns the bit field where the exception occurred.

Specified by:

getSource in interface BitStorageException

Returns:

the instance throwing this exception

getIndex

public long getIndex()

Returns the invalid bit index.

Returns:

the index that was provided when calling the constructor