Escape (wcomponents-core 1.5.24 API)

java.lang.Object
- java.lang.Throwable
- - java.lang.Exception
  - - java.lang.RuntimeException
    - - com.github.bordertech.wcomponents.Escape

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ActionEscape
```
public class Escape
extends RuntimeException
```
An escape can be thrown during servicing in which case the WComponent's paint will not be used, instead the escape method will be called, after the setRequest and setResponse methods are called. This can be used to do forwarding, etc.

Author:

Martin Shevchenko

See Also:

Serialized Form

Constructor Summary

Constructors
Modifier	Constructor	Description
	`Escape()`	Default constructor.
`protected`	`Escape(String message, Throwable cause)`	Constructor that allows a message and cause to be provided.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`escape()`	Subclasses can override this and do whatever they need to.
`Request`	`getRequest()`
`Response`	`getResponse()`
`void`	`setRequest(Request request)`	Sets the request being responded to.
`void`	`setResponse(Response response)`	Sets the client response.

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
  - Escape
```
public Escape()
```
    Default constructor.
  - Escape
```
protected Escape(String message,
                 Throwable cause)
```
    Constructor that allows a message and cause to be provided.
    
    Parameters:
    
    message - the exception message
    
    cause - the original cause
- Method Detail
  - getRequest
```
public Request getRequest()
```
    Returns:
    
    the request being responded to.
  - setRequest
```
public void setRequest(Request request)
```
    Sets the request being responded to.
    
    Parameters:
    
    request - the request to set.
  - getResponse
```
public Response getResponse()
```
    Returns:
    
    the response to the client.
  - setResponse
```
public void setResponse(Response response)
```
    Sets the client response.
    
    Parameters:
    
    response - the response to set.
  - escape
```
public void escape()
            throws IOException
```
    Subclasses can override this and do whatever they need to.
    
    Throws:
    
    IOException - IOException