Package com.alachisoft.ncache.runtime.exceptions.runtime

Class CacheRuntimeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.alachisoft.ncache.runtime.exceptions.runtime.CacheRuntimeException

Direct Known Subclasses:

AggregateRuntimeException, ConfigurationRuntimeException, ConnectionRuntimeException, GeneralFailureRuntimeException, InvalidReaderRuntimeException, LicensingRuntimeException, OperationFailedRuntimeException, OperationNotSupportedRuntimeException, SecurityRuntimeException, StateTransferInProgressRuntimeException

public class CacheRuntimeException
extends java.lang.RuntimeException

It is the base class for all the exceptions that are thrown from NCache. So you can catch this exception for all the exceptions thrown from within the cache.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
CacheRuntimeException()	Constructs an CacheException with null as its error detail message.
CacheRuntimeException(int errorCode, java.lang.String reason)	Constructs a new CacheRuntime exception with the specified errorCode and reason
CacheRuntimeException(int errorCode, java.lang.String reason, java.lang.String stackTrace)	Constructs a new CacheRuntime exception with the specified errorCode and reason and stacktrace
CacheRuntimeException(java.lang.String s)	Constructs an CacheException with the specified detail message.
CacheRuntimeException(java.lang.String message, java.lang.Throwable cause)	Constructs a new CacheRuntime exception with the specified detail message and cause.
CacheRuntimeException(java.lang.Throwable cause)	Constructs a new CacheRuntime exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).

Method Summary

Modifier and Type	Method	Description
int	getErrorCode()	Retreive error code
void	printStackTrace()	Prints this throwable and its backtrace to the standard error stream.
void	setErrorCode(int value)	Sets ErrorCode

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from class java.lang.Throwable

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

Constructor Detail

CacheRuntimeException

public CacheRuntimeException()

Constructs an CacheException with null as its error detail message.

CacheRuntimeException

public CacheRuntimeException(int errorCode,
                             java.lang.String reason)

Constructs a new CacheRuntime exception with the specified errorCode and reason

Parameters:

errorCode - assigned Error code

reason - detail message

CacheRuntimeException

public CacheRuntimeException(int errorCode,
                             java.lang.String reason,
                             java.lang.String stackTrace)

Constructs a new CacheRuntime exception with the specified errorCode and reason and stacktrace

Parameters:

errorCode - assigned Error code

reason - detail message

stackTrace - stackTrace

CacheRuntimeException

public CacheRuntimeException(java.lang.String s)

Constructs an CacheException with the specified detail message. The error message string s can later be retrieved by the Throwable.getMessage() method of class java.lang.Throwable.

Parameters:

s - the detail message.

CacheRuntimeException

public CacheRuntimeException(java.lang.Throwable cause)

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

Parameters:

cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

Since:

1.4

CacheRuntimeException

public CacheRuntimeException(java.lang.String message,
                             java.lang.Throwable cause)

Constructs a new CacheRuntime exception with the specified detail message and cause.

Note that the detail message associated with cause is not automatically incorporated in this runtime 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). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

Since:

1.4

Method Detail

printStackTrace

public void printStackTrace()

Prints this throwable and its backtrace to the standard error stream. This method prints a stack trace for this Throwable object on the error output stream that is the value of the field System.err. The first line of output contains the result of the Throwable.toString() method for this object. Remaining lines represent data previously recorded by the method Throwable.fillInStackTrace(). The format of this information depends on the implementation, but the following example may be regarded as typical:

 java.lang.NullPointerException
         at MyClass.mash(MyClass.java:9)
         at MyClass.crunch(MyClass.java:6)
         at MyClass.main(MyClass.java:3)
 

This example was produced by running the program:

 class MyClass {
     public static void main(String[] args) {
         crunch(null);
     }
     static void crunch(int[] a) {
         mash(a);
     }
     static void mash(int[] b) {
         System.out.println(b[0]);
     }
 }
 

The backtrace for a throwable with an initialized, non-null cause should generally include the backtrace for the cause. The format of this information depends on the implementation, but the following example may be regarded as typical:

 HighLevelException: MidLevelException: LowLevelException
         at Junk.a(Junk.java:13)
         at Junk.main(Junk.java:4)
 Caused by: MidLevelException: LowLevelException
         at Junk.c(Junk.java:23)
         at Junk.b(Junk.java:17)
         at Junk.a(Junk.java:11)
         ... 1 more
 Caused by: LowLevelException
         at Junk.e(Junk.java:30)
         at Junk.d(Junk.java:27)
         at Junk.c(Junk.java:21)
         ... 3 more
 

Note the presence of lines containing the characters "...". These lines indicate that the remainder of the stack trace for this exception matches the indicated number of frames from the bottom of the stack trace of the exception that was caused by this exception (the "enclosing" exception). This shorthand can greatly reduce the length of the output in the common case where a wrapped exception is thrown from same method as the "causative exception" is caught. The above example was produced by running the program:

 public class Junk {
     public static void main(String args[]) {
         try {
             a();
         } catch(HighLevelException e) {
             e.printStackTrace();
         }
     }
     static void a() throws HighLevelException {
         try {
             b();
         } catch(MidLevelException e) {
             throw new HighLevelException(e);
         }
     }
     static void b() throws MidLevelException {
         c();
     }
     static void c() throws MidLevelException {
         try {
             d();
         } catch(LowLevelException e) {
             throw new MidLevelException(e);
         }
     }
     static void d() throws LowLevelException {
        e();
     }
     static void e() throws LowLevelException {
         throw new LowLevelException();
     }
 }

 class HighLevelException extends Exception {
     HighLevelException(Throwable cause) { super(cause); }
 }

 class MidLevelException extends Exception {
     MidLevelException(Throwable cause)  { super(cause); }
 }

 class LowLevelException extends Exception {
 }
 

As of release 7, the platform supports the notion of suppressed exceptions (in conjunction with the try-with-resources statement). Any exceptions that were suppressed in order to deliver an exception are printed out beneath the stack trace. The format of this information depends on the implementation, but the following example may be regarded as typical:

 Exception in thread "main" java.lang.Exception: Something happened
  at Foo.bar(Foo.java:10)
  at Foo.main(Foo.java:5)
  Suppressed: Resource$CloseFailException: Resource ID = 0
          at Resource.close(Resource.java:26)
          at Foo.bar(Foo.java:9)
          ... 1 more
 

Note that the "... n more" notation is used on suppressed exceptions just at it is used on causes. Unlike causes, suppressed exceptions are indented beyond their "containing exceptions."

An exception can have both a cause and one or more suppressed exceptions:

 Exception in thread "main" java.lang.Exception: Main block
  at Foo3.main(Foo3.java:7)
  Suppressed: Resource$CloseFailException: Resource ID = 2
          at Resource.close(Resource.java:26)
          at Foo3.main(Foo3.java:5)
  Suppressed: Resource$CloseFailException: Resource ID = 1
          at Resource.close(Resource.java:26)
          at Foo3.main(Foo3.java:5)
 Caused by: java.lang.Exception: I did it
  at Foo3.main(Foo3.java:8)
 

Likewise, a suppressed exception can have a cause:

 Exception in thread "main" java.lang.Exception: Main block
  at Foo4.main(Foo4.java:6)
  Suppressed: Resource2$CloseFailException: Resource ID = 1
          at Resource2.close(Resource2.java:20)
          at Foo4.main(Foo4.java:5)
  Caused by: java.lang.Exception: Rats, you caught me
          at Resource2$CloseFailException.<init>(Resource2.java:45)
          ... 2 more
 

Overrides:

printStackTrace in class java.lang.Throwable

getErrorCode

public final int getErrorCode()

Retreive error code

Returns:

setErrorCode

public final void setErrorCode(int value)

Sets ErrorCode

Parameters:

value - error code