sam.event
Class ProgressEvent

java.lang.Object
  |
  +--sam.event.ProgressEvent

public class ProgressEvent
extends java.lang.Object

Class summarizing informations about the current progress state. Note that this class has no public constructor as it should only be instantiated through a ProgressEventNotifier.

See Also:
ProgressEventNotifier

Nested Class Summary
static class ProgressEvent.Statistics
          Partial statistics
 
Field Summary
 java.lang.String currentEntryName
          The name of the entry being currently processed
static sam.event.ProgressEvent DUMMY
          Dummy entry for testing/debugging purpose
 ProgressEvent.Statistics entry
          Statistics on current entry
 ProgressEvent.Statistics global
          Global statistics
 int numberOfCurrentEntry
          The number of the current entry
 int totalEntriesCount
          The total number of entries
 
Method Summary
 java.lang.String currentEntryShortName(int length)
          Gets a shorter name for the entry being currently processed
 boolean isNextEntry()
          Wether this is the first event concerning the current entry, i.e.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

DUMMY

public static final sam.event.ProgressEvent DUMMY
Dummy entry for testing/debugging purpose


entry

public final ProgressEvent.Statistics entry
Statistics on current entry


global

public final ProgressEvent.Statistics global
Global statistics


currentEntryName

public final java.lang.String currentEntryName
The name of the entry being currently processed


numberOfCurrentEntry

public final int numberOfCurrentEntry
The number of the current entry


totalEntriesCount

public final int totalEntriesCount
The total number of entries

Method Detail

currentEntryShortName

public java.lang.String currentEntryShortName(int length)
Gets a shorter name for the entry being currently processed

Parameters:
length - the length of the desired shorter name

isNextEntry

public boolean isNextEntry()
Wether this is the first event concerning the current entry, i.e. if this is an event corresponding to a new entry


toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object