FIPAException (de.enflexit.jade 4.6.0 API)

java.lang.Object
- java.lang.Throwable
- - java.lang.Exception
  - - jade.domain.FIPAException

All Implemented Interfaces:

ContentElement, Predicate, Serializable, Serializable

Direct Known Subclasses:

FailureException, NotUnderstoodException, RefuseException
```
public class FIPAException
extends Exception
implements Predicate
```
This class represents a generic FIPAException, i.e. one of NotUnderstood,Failure,Refuse, as defined in jade.domain.FIPAAgentManagement. It has two constructors, one based on an ACLMessage, and the second based on its content, i.e. the exception message.

Version:

$Date$ $Revision$

Author:

Giovanni Rimassa - Universita' di Parma

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected ACLMessage msg

Constructor Summary

Constructors
Constructor	Description
`FIPAException(ACLMessage message)`	Constructs a `FIPAException` from the given ACL message.
`FIPAException(String message)`	Constructs a generic `FIPAException`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ACLMessage`	`getACLMessage()`	Retrieve the ACL message whose content is represented by this exception.
`String`	`getMessage()`	Get the content of the ACL message representing this exception
`protected void`	`setMessage(String message)`	Set the content of the ACL message representing this exception

Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, 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
  - msg
```
protected ACLMessage msg
```
- Constructor Detail
  - FIPAException
```
public FIPAException(String message)
```
    Constructs a generic FIPAException. The ACL message performative is defaulted to not-understood.
    
    Parameters:
    
    message - is the content of the ACLMessage
  - FIPAException
```
public FIPAException(ACLMessage message)
```
    Constructs a FIPAException from the given ACL message.
    
    Parameters:
    
    message - is the ACL message representing this exception
- Method Detail
  - getACLMessage
```
public ACLMessage getACLMessage()
```
    Retrieve the ACL message whose content is represented by this exception.
    
    Returns:
    
    the ACLMessage representing this exception
  - setMessage
```
protected void setMessage(String message)
```
    Set the content of the ACL message representing this exception
    
    Parameters:
    
    message - is the content
  - getMessage
```
public String getMessage()
```
    Get the content of the ACL message representing this exception
    
    Overrides:
    
    getMessage in class Throwable
    
    Returns:
    
    A string representing the message content that describes this FIPA exception.