Class MessageRecipient<S extends GenericSimulation<S,A,C,D,DM,F,G>,A extends GenericActor<S,A,C,D,DM,F,G>,C extends GenericCondition<S,A,C,D,DM,F,G>,D extends GenericDomain<S,A,C,D,DM,F,G>,DM extends GenericDomainMember<S,A,C,D,DM,F,G>,F extends GenericFactory<S,A,C,D,DM,F,G>,G extends GenericGroup<S,A,C,D,DM,F,G>>

java.lang.Object
org.bzdev.devqsim.SimObject
org.bzdev.drama.generic.GenericSimObject<S,A,C,D,DM,F,G>
org.bzdev.drama.generic.GenericTaskObject<S,A,C,D,DM,F,G>
org.bzdev.drama.common.MessageRecipient<S,A,C,D,DM,F,G>
All Implemented Interfaces:
NamedObjectOps
Direct Known Subclasses:
GenericMsgRecipient

public abstract class MessageRecipient<S extends GenericSimulation<S,A,C,D,DM,F,G>,A extends GenericActor<S,A,C,D,DM,F,G>,C extends GenericCondition<S,A,C,D,DM,F,G>,D extends GenericDomain<S,A,C,D,DM,F,G>,DM extends GenericDomainMember<S,A,C,D,DM,F,G>,F extends GenericFactory<S,A,C,D,DM,F,G>,G extends GenericGroup<S,A,C,D,DM,F,G>> extends GenericTaskObject<S,A,C,D,DM,F,G>
Class for message recipients. This class specifies the common behavior of all message recipients (e.g, actors and groups).

The full implementation is in the package org.bzdev.drama.generic. This class is provided for use by SimulationAdapter and thus contains only a specification of public methods and a constructor.

  • Constructor Details

    • MessageRecipient

      protected MessageRecipient(S sim, String name, boolean intern) throws IllegalArgumentException
      Constructor.
      Parameters:
      sim - the simulation
      name - the name of the agent
      intern - true if the object can be looked up by using the methods in Simulation; false otherwise.
      Throws:
      IllegalArgumentException - typically means a name is already in use
  • Method Details

    • getGroups

      public abstract Set<G> getGroups()
      Get the groups for which this message recipient is a member.
      Returns:
      the set of groups for which this message recipient is a member
    • inGroup

      public abstract boolean inGroup(G g)
      Determine if a message recipient is in a group
      Parameters:
      g - the group to test
      Returns:
      true if a group member of g, false otherwise
    • joinGroup

      public abstract boolean joinGroup(G g) throws IllegalArgumentException
      Join a group.
      Parameters:
      g - the group to join
      Returns:
      true if new member; false already a member
      Throws:
      IllegalArgumentException - the addition of the group would create a loop in which two groups (perhaps via other groups) were members of each other
    • joinGroup

      public abstract boolean joinGroup(G g, GroupInfo info) throws IllegalArgumentException
      Join a group. Group-specific behavior is provided by the group being joined.
      Parameters:
      g - the group to join
      info - an object containing additional information about a group member, with the semantics determined by subclasses of MessageRecipient (i.e., GenericActor and GenericGroup and their subclasses)
      Returns:
      true if new member; false already a member
      Throws:
      IllegalArgumentException - the addition of the group would create a loop in which two groups (perhaps via other groups) were members of each other; the info argument has the wrong subtype
    • leaveGroup

      public abstract boolean leaveGroup(G g)
      Leave a group.
      Parameters:
      g - the group to leave
      Returns:
      true if this object is a member of g; false otherwise
    • clone

      protected Object clone() throws CloneNotSupportedException
      Creates and returns a copy of this object. This method will throw the exception CloneNotSupportedException if the object is interned.
      Overrides:
      clone in class Object
      Throws:
      CloneNotSupportedException - a clone could not be created
      See Also:
    • isInterned

      public boolean isInterned()
      Determine if an object is interned in a object namer's tables.
      Specified by:
      isInterned in interface NamedObjectOps
      Returns:
      true if the object is interned; false if not
    • getObjectNamer

      protected Simulation getObjectNamer()
      Get the object namer for a named object.
      Returns:
      the object namer for this named object
    • getName

      public final String getName()
      Get an object's name.
      Specified by:
      getName in interface NamedObjectOps
      Returns:
      the name of the object
    • canDelete

      public boolean canDelete()
      Determine if this named object can be deleted. A named object can be deleted if the method delete has not been called and if the object is not in a state that prevents the object from being deleted. Subclasses that override this method must call canDelete() for their superclasses and return false if the superclass' canDelete method returns false. The default method returns true if delete() has not been called and returned true.
      Specified by:
      canDelete in interface NamedObjectOps
      Returns:
      true if this object can be deleted; false otherwise
    • delete

      public final boolean delete()
      Delete an object. An object can only be deleted once. If this method returns true, the object (if interned) will have been removed from the object namer tables.

      The implementations provided by DefaultNamedObect and generated because of a @NamedObject annotation provide a protected method named onDelete. A subclass that overrides onDelete() must call the onDelete method of its superclass after it's onDelete method has been called and any cleanup actions performed. In some cases, this may happen at a later time (e.g., if a thread is used for some of the cleanup operations or if it is otherwise necessary to wait).

      Specified by:
      delete in interface NamedObjectOps
      Returns:
      true if the deletion request was accepted; false otherwise
    • isDeleted

      public final boolean isDeleted()
      Determine if an object has been deleted. An object is deleted if the method delete() has been called and returned true.
      Specified by:
      isDeleted in interface NamedObjectOps
      Returns:
      true if deleted; false otherwise
    • deletePending

      public final boolean deletePending()
      Determine if an object is being deleted. An deletion is pending if the method delete() has been called and returned true but the deletion has not been completed.
      Specified by:
      deletePending in interface NamedObjectOps
      Returns:
      true if deletion is pending; false otherwise