jade.domain
Class FIPAException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--jade.domain.FIPAException
All Implemented Interfaces:
ContentElement, Predicate, Serializable, java.io.Serializable
Direct Known Subclasses:
FailureException, NotUnderstoodException, RefuseException

public class FIPAException
extends java.lang.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: 2003-11-18 17:26:38 +0100 (mar, 18 nov 2003) $ $Revision: 4565 $
Author:
Giovanni Rimassa - Universita' di Parma
See Also:
Serialized Form

Constructor Summary
FIPAException(ACLMessage message)
          Constructs a FIPAException from the given ACL message.
FIPAException(java.lang.String message)
          Constructs a generic FIPAException.
 
Method Summary
 ACLMessage getACLMessage()
          Retrieve the ACL message whose content is represented by this exception.
 java.lang.String getMessage()
          Get the content of the ACL message representing this exception
protected  void setMessage(java.lang.String message)
          Set the content of the ACL message representing this exception
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, 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

FIPAException

public FIPAException(java.lang.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(java.lang.String message)
Set the content of the ACL message representing this exception

Parameters:
message - is the content

getMessage

public java.lang.String getMessage()
Get the content of the ACL message representing this exception

Overrides:
getMessage in class java.lang.Throwable
Returns:
A string representing the message content that describes this FIPA exception.


JADE