rcf.core.util.position
Class SentinelPositionException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          java.lang.RuntimeException
              java.lang.IllegalStateException
                  rcf.core.util.position.SentinelPositionException

All Implemented Interfaces:

Serializable

@Revision(value="$Revision: 1.5 $",
          date="$Date: 2006/12/16 17:53:21 $",
          tag="$Name:  $")
public class SentinelPositionException
extends IllegalStateException

Indicates that a method call to a position or iterator could not be executed because one or more of the positions was a sentinel, when an element bearing position was required. For example OrderedBiPosition.addAfter(Object) throws this exception.

TODO: Javadoc review, Seal/Finalize

Version:

$Revision: 1.5 $

Author:

Greg Gibeling

See Also:

Serialized Form

Field Summary

private static long

serialVersionUID An unique class level ID for use by the java serialization code.

Constructor Summary

SentinelPositionException()
Constructs an SentinelPositionException with no detailed message.

SentinelPositionException(String message)
Constructs an SentinelPositionException with the specified detailed message.

SentinelPositionException(String message, Throwable cause)
Constructs an SentinelPositionException with the specified detailed message and cause.

SentinelPositionException(Throwable cause)
Constructs an SentinelPositionException with the specified cause and a detailed message of (cause == null) ? null : cause.toString(), which typically contains the class and detail message of cause.

Method Summary

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

An unique class level ID for use by the java serialization code.

See Also:

Constant Field Values

Constructor Detail

SentinelPositionException

public SentinelPositionException()

Constructs an SentinelPositionException with no detailed message.

SentinelPositionException

public SentinelPositionException(String message)

Constructs an SentinelPositionException with the specified detailed message.

Parameters:

message - The detailed message.

SentinelPositionException

public SentinelPositionException(String message,
                                 Throwable cause)

Constructs an SentinelPositionException with the specified detailed message and cause.

Notice that the detailed message associated with cause is not automatically incorporated in this exception's detail message.

Parameters:

message - The detail message (which is saved for later retrieval by the Throwable.getMessage() method).

cause - The cause (which is saved for later retrieval by the Throwable.getCause() method). null values are permitted, and indicate that the cause is nonexistent or unknown.

SentinelPositionException

public SentinelPositionException(Throwable cause)

Constructs an SentinelPositionException with the specified cause and a detailed message of (cause == null) ? null : cause.toString(), which typically contains the class and detail message of cause. This constructor is useful for exceptions that are little more than wrappers for other throwables.

Parameters:

cause - he cause (which is saved for later retrieval by the Throwable.getCause() method). null values are permitted, and indicate that the cause is nonexistent or unknown.