RedirectException (formcycle: bom 8.2.0 API)

java.lang.Object
- java.lang.Throwable
- - java.lang.Exception
  - - de.xima.fc.exceptions.http.RedirectException

All Implemented Interfaces:

IRedirectAction, Serializable
```
public class RedirectException
extends Exception
implements IRedirectAction
```
An exception that also indicates a redirection action.

Since:

8.0.1

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class RedirectException.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`IUrlResource`	`getTarget()`
`ViewMessage`	`getViewMessage()`
`static RedirectException.Builder`	`newBuilder(IUrlResource target)`
`static RedirectException.Builder`	`newBuilder(String target)`

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

- Method Detail
  - newBuilder
```
public static RedirectException.Builder newBuilder(IUrlResource target)
```
  - newBuilder
```
public static RedirectException.Builder newBuilder(String target)
```
  - getTarget
```
public IUrlResource getTarget()
```
    Specified by:
    
    getTarget in interface IRedirectAction
    
    Returns:
    
    a URL resource of where to redirect to.
  - getViewMessage
```
@Nullable
public ViewMessage getViewMessage()
```
    Specified by:
    
    getViewMessage in interface IRedirectAction
    
    Returns:
    
    an optional view message that is to be displayed upon redirection.