org.bushe.swing.event.PublicationStatusTracker Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of nifty Show documentation

Nifty GUI is a Java Library that supports the building of interactive user interfaces for games or similar applications. It utilizes OpenGL for rendering and it can be easily integrated into many rendering systems. The configuration of the GUI is stored in xml files with little supporting Java code. In short Nifty helps you to layout stuff, display it in a cool way and interact with it :)

The newest version!

package org.bushe.swing.event;

/**
 * An optional interface that can be implemented by Events objects or topic Payloads
 * to enable the events' status to be stamped on the event by an event service.
 * 
 * EventService implementations must call setEventStatus(status) on event objects and
 * payloads that implement this interface.
 */
public interface PublicationStatusTracker {

   /**
    * Implementations of this method must be made thread safe.
    * @return last value set by setPublicationStatus(), or
    * {@link PublicationStatus#Unpublished} if setPublicationStatus was never called.
    */
   public PublicationStatus getPublicationStatus();

   /**
    * Implementations of this method must be made thread safe.
    * @param status the status of the event during it's current publication
    */
   public void setPublicationStatus(PublicationStatus status);
}