LiveGraph
data visualisation and analysis framework

org.LiveGraph.dataCache
Enum DataUpdateEvent

java.lang.Object
  extended by java.lang.Enum<DataUpdateEvent>
      extended by org.LiveGraph.dataCache.DataUpdateEvent
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<DataUpdateEvent>, EventType

public enum DataUpdateEvent
extends java.lang.Enum<DataUpdateEvent>
implements EventType

Event types related to data updates.

This product includes software developed by the LiveGraph project and its contributors.
(http://www.live-graph.org)
Copyright (c) 2007-2008 G. Paperin.
All rights reserved.

File: UpdateInvokerObserver.java

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following terms and conditions are met:

1. Redistributions of source code must retain the above acknowledgement of the LiveGraph project and its web-site, the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above acknowledgement of the LiveGraph project and its web-site, the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. All advertising materials mentioning features or use of this software or any derived software must display the following acknowledgement:
This product includes software developed by the LiveGraph project and its contributors.
(http://www.live-graph.org)

4. All advertising materials distributed in form of HTML pages or any other technology permitting active hyper-links that mention features or use of this software or any derived software must display the acknowledgment specified in condition 3 of this agreement, and in addition, include a visible and working hyper-link to the LiveGraph homepage (http://www.live-graph.org).

THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS, CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Version:
"2.0.beta01"
Author:
Greg Paperin (http://www.paperin.org)

Enum Constant Summary
UPDIN_CannotInitiateUpdate
           Info parameter Value getInfoBoolean() unspecified getInfoLong() unspecified getInfoDouble() unspecified getInfoObject() Error message (String)
UPDIN_EndMemoryStreamMode
          Validated before switching from memory stream mode into normal (data file) mode, if validation fails the switching is not performed; event is raised directly after switching to notify the application.
UPDIN_InitiateUpdate
           Info parameter Value getInfoBoolean() true if the DataStreamReader object should be closed at the end of the update, false if the DataStreamReader should not be closed at the end of the update getInfoLong() unspecified getInfoDouble() unspecified getInfoObject() The DataStreamReader object that is the source for the update.
UPDIN_StartMemoryStreamMode
          Validated before switching into memory stream mode, if validation fails the switching is not performed; event is raised directly after switching to notify the application.
UPDIN_TimerTick
           Info parameter Value getInfoBoolean() unspecified getInfoLong() unspecified getInfoDouble() unspecified getInfoObject() unspecified
UPDIN_UpdateFinishError
           Info parameter Value getInfoBoolean() unspecified getInfoLong() unspecified getInfoDouble() unspecified getInfoObject() a String containg the error message
UPDIN_UpdateFinishSuccess
           Info parameter Value getInfoBoolean() unspecified getInfoLong() unspecified getInfoDouble() unspecified getInfoObject() unspecified
UPDIN_UpdateStart
          Validated before actually starting an update, if validation fails the update is not started.
 
Method Summary
static DataUpdateEvent valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static DataUpdateEvent[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

UPDIN_InitiateUpdate

public static final DataUpdateEvent UPDIN_InitiateUpdate
Info parameter Value
getInfoBoolean() true if the DataStreamReader object should be closed at the end of the update, false if the DataStreamReader should not be closed at the end of the update
getInfoLong() unspecified
getInfoDouble() unspecified
getInfoObject() The DataStreamReader object that is the source for the update.


UPDIN_CannotInitiateUpdate

public static final DataUpdateEvent UPDIN_CannotInitiateUpdate
Info parameter Value
getInfoBoolean() unspecified
getInfoLong() unspecified
getInfoDouble() unspecified
getInfoObject() Error message (String)


UPDIN_TimerTick

public static final DataUpdateEvent UPDIN_TimerTick
Info parameter Value
getInfoBoolean() unspecified
getInfoLong() unspecified
getInfoDouble() unspecified
getInfoObject() unspecified


UPDIN_UpdateStart

public static final DataUpdateEvent UPDIN_UpdateStart
Validated before actually starting an update, if validation fails the update is not started.
Info parameter Value
getInfoBoolean() unspecified
getInfoLong() unspecified
getInfoDouble() unspecified
getInfoObject() unspecified


UPDIN_StartMemoryStreamMode

public static final DataUpdateEvent UPDIN_StartMemoryStreamMode
Validated before switching into memory stream mode, if validation fails the switching is not performed; event is raised directly after switching to notify the application.
Info parameter Value
getInfoBoolean() unspecified
getInfoLong() unspecified
getInfoDouble() unspecified
getInfoObject() unspecified


UPDIN_EndMemoryStreamMode

public static final DataUpdateEvent UPDIN_EndMemoryStreamMode
Validated before switching from memory stream mode into normal (data file) mode, if validation fails the switching is not performed; event is raised directly after switching to notify the application.
Info parameter Value
getInfoBoolean() unspecified
getInfoLong() unspecified
getInfoDouble() unspecified
getInfoObject() unspecified


UPDIN_UpdateFinishSuccess

public static final DataUpdateEvent UPDIN_UpdateFinishSuccess
Info parameter Value
getInfoBoolean() unspecified
getInfoLong() unspecified
getInfoDouble() unspecified
getInfoObject() unspecified


UPDIN_UpdateFinishError

public static final DataUpdateEvent UPDIN_UpdateFinishError
Info parameter Value
getInfoBoolean() unspecified
getInfoLong() unspecified
getInfoDouble() unspecified
getInfoObject() a String containg the error message

Method Detail

values

public static DataUpdateEvent[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (DataUpdateEvent c : DataUpdateEvent.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static DataUpdateEvent valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

LiveGraph
data visualisation and analysis framework