groovy.lang
Class DeprecationException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          java.lang.RuntimeException
              groovy.lang.DeprecationException

All Implemented Interfaces:

Serializable

public class DeprecationException
extends RuntimeException

Use this exception to mark a method implementation as being deprecated. Use the message to indicate the recommended way of calling the desired functionality. Make throwing this exception the only line in the method implementation, i.e. unlike the JavaDoc deprecated feature there is no relay to the new implementation but an early and deliberate halt of execution ("fail early"). This exception is supposed to be used in the SNAPSHOT releases only. Before release, all references to this exception should be resolved and the according methods removed.

Author:

Dierk Koenig

See Also:

Serialized Form

Constructor Summary

DeprecationException(String message)

DeprecationException(String message, Throwable 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

Constructor Detail

DeprecationException

public DeprecationException(String message)

DeprecationException

public DeprecationException(String message,
                            Throwable cause)