src/appletbots/CollisionException.java

   1 /*
   2  * Copyright (c) 2002 Erik Rasmussen - All Rights Reserverd
   3  */
   4 package appletbots;
   5
   6 /**
   7  * This exception is thrown when two objects collide
   8  *
   9  * @author Erik Rasmussen
  10  */
  11 public class CollisionException extends Exception
  12 {
  13         /**
  14          * The collider.  The object that is colliding with the collidee.
  15          */
  16         private WorldObject collider;
  17         /**
  18          * The collidee.  The object that the collider is colliding with.
  19          */
  20         private WorldObject collidee;
  21
  22         /**
  23          * Creates a new CollisionException with the given collider and collidee
  24          *
  25          * @param collider The collider.  The object that is colliding with the collidee.
  26          * @param collidee The collidee.  The object that the collider is colliding with.
  27          */
  28         public CollisionException(final WorldObject collider, final WorldObject collidee)
  29         {
  30                 super();
  31                 this.collider = collider;
  32                 this.collidee = collidee;
  33         }
  34
  35         /**
  36          * Creates a new CollisionException with the given error message
  37          *
  38          * @param message The error message
  39          */
  40         public CollisionException(final String message)
  41         {
  42                 super(message);
  43         }
  44
  45         /**
  46          * Creates a new CollisionException
  47          */
  48         public CollisionException()
  49         {
  50                 super();
  51         }
  52
  53         /**
  54          * Returns the collider.  The object that is colliding with the collidee.
  55          *
  56          * @return The collider.  The object that is colliding with the collidee.
  57          */
  58         public WorldObject getCollider()
  59         {
  60                 return collider;
  61         }
  62
  63         /**
  64          * Returns the collidee.  The object that the collider is colliding with.
  65          *
  66          * @return The collidee.  The object that the collider is colliding with.
  67          */
  68         public WorldObject getCollidee()
  69         {
  70                 return collidee;
  71         }
  72 }