FreeColException (FreeCol Code Documentation)

java.lang.Object
- java.lang.Throwable
- - java.lang.Exception
  - - net.sf.freecol.common.FreeColException

All Implemented Interfaces:

java.io.Serializable
```
public final class FreeColException
extends java.lang.Exception
```
The Exception thrown by the FreeCol application.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

private boolean allowDebug
Should this exception allow debug runs to continue?

Constructor Summary

Constructors
Constructor	Description
`FreeColException(java.lang.String message)`	Build a new FreeCol specific exception with the given message.
`FreeColException(java.lang.String message, java.lang.Throwable throwable)`	Build a new FreeCol specific exception with the given message.
`FreeColException(java.lang.Throwable throwable)`	Build a new FreeCol specific exception with the given message.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`debugAllowed()`	Get the debug state.
`FreeColException`	`preserveDebug()`	Make this exception not cause debug runs to end.

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

- Field Detail
  - allowDebug
```
private boolean allowDebug
```
    Should this exception allow debug runs to continue?
- Constructor Detail
  - FreeColException
```
public FreeColException(java.lang.String message)
```
    Build a new FreeCol specific exception with the given message.
    
    Parameters:
    
    message - The message for this exception.
  - FreeColException
```
public FreeColException(java.lang.String message,
                        java.lang.Throwable throwable)
```
    Build a new FreeCol specific exception with the given message.
    
    Parameters:
    
    message - The message for this exception.
    
    throwable - The Throwable cause for the exception.
  - FreeColException
```
public FreeColException(java.lang.Throwable throwable)
```
    Build a new FreeCol specific exception with the given message.
    
    Parameters:
    
    throwable - The Throwable cause for the exception.
- Method Detail
  - preserveDebug
```
public FreeColException preserveDebug()
```
    Make this exception *not* cause debug runs to end.
    
    Returns:
    
    This exception.
  - debugAllowed
```
public boolean debugAllowed()
```
    Get the debug state.
    
    Returns:
    
    Whether debug runs should continue following this exception.