gov.sandia.ccaffeine.dc.user_iface.MVC.event
Class NukeAllEvent

java.lang.Object
  java.util.EventObject
      gov.sandia.ccaffeine.dc.user_iface.MVC.event.NukeAllEvent

All Implemented Interfaces:

java.io.Serializable

public class NukeAllEvent
extends java.util.EventObject

Used to notify components that an entity wants to delete all components. A view might respond by removing all components from the main workspace (the arena).

See Also:

Serialized Form

Field Summary

protected java.lang.String	entity The entity that is to be removed.
protected int	numberOfArguments

Fields inherited from class java.util.EventObject

source

Constructor Summary

NukeAllEvent(java.lang.Object source)
Create a NukeEvent.

NukeAllEvent(java.lang.Object source, int numberOfArguments, java.lang.String entity)
Create a NukeEvent.

NukeAllEvent(java.lang.Object source, java.lang.String entity)
Create a NukeEvent.

Method Summary

java.lang.String	getEntity() Get the entity that is to be removed.
int	getNumberOfArguments() Retrieve the number of arguments in the nuke command.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

numberOfArguments

protected int numberOfArguments

entity

protected java.lang.String entity

The entity that is to be removed. NOTE: As of Oct 2003, "all" is the only entity that can be nuked.

Constructor Detail

NukeAllEvent

public NukeAllEvent(java.lang.Object source)

Create a NukeEvent. The event can be used to notify components that an entity wants to delete all components. A view might respond by sending a "nuke all" message to the cca server.

Parameters:

source - The entity that created this event.

NukeAllEvent

public NukeAllEvent(java.lang.Object source,
                    java.lang.String entity)

Create a NukeEvent. The event can be used to notify components that an entity wants to delete all components. A view might respond by sending a "nuke all" message to the cca server.

Parameters:

source - The entity that created this event.

entity - The entity that is to be removed. NOTE: As of Oct 2003, "all" is the only entity that can be nuked.

NukeAllEvent

public NukeAllEvent(java.lang.Object source,
                    int numberOfArguments,
                    java.lang.String entity)

Create a NukeEvent. The event can be used to notify components that an entity wants to delete all components. A view might respond by removing all components from the main workspace (the arena).

Parameters:

source - The entity that created this event.

numberOfArguments - The number of arguments in the nuke command.

entity - The entity that is to be removed. NOTE: As of Oct 2003, "all" is the only entity that can be nuked.

Method Detail

getNumberOfArguments

public int getNumberOfArguments()

Retrieve the number of arguments in the nuke command.

Returns:

The number of arguments in the nuke command.

getEntity

public java.lang.String getEntity()

Get the entity that is to be removed. NOTE: As of Oct 2003, "all" is the only entity that can be nuked.