org.vishia.event

Class EventSource

java.lang.Object

org.vishia.event.EventSource

Direct Known Subclasses:

TimeOrder

public class EventSource
extends java.lang.Object

Access to the current source of a event. It is referred inside any event. The source is that class, which has transmitted the event. Usual an event which were transmitted has no more connection to the source of it. But especially for debugging situations it may be a point of interest whether and when the event is processed. For debugging it may be a point of interest which instance is the source of an event.

This is a class, not an interface, because it contains a name for debugging. The user can instantiate the class as an inner anonymous class with following scheme:

  EventSource theSource = new EventSource("debugname"){

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	name The name is private because it is only used for toString().
static EventSource	nullSource A default source with empty methods.
static int	version Version, history and license The meaning and name is changed.

Constructor Summary

Constructors

Constructor and Description
EventSource(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
void	notifyConsumed(int state) This operation is called after calling EventConsumer.processEvent(java.util.EventObject) in EventTimerThread and should be called also in all other implementations of EventThread_ifc to assign, how the event is used.
void	notifyDequeued() It is called if the event is dequeued from the EventWithDst.evDstThread queue and attempt to processed.
void	notifyRelinquished(int ctConsumed)
void	notifyShouldOccupyButInUse()
void	notifyShouldSentButInUse()
void	notifyUnexpectedException(java.lang.CharSequence msg)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

version

public static final int version

Version, history and license

• The meaning and name is changed. It is only a debugging helper. The functionality of freeing is solved in the EventCmdtype class.
• 2012-03-10 Hartmut created: It is a problem if a request may be crashed in a remote device, but the event is reserved for answer in the proxy. It should be freed. Events may be re-used.

Copyright/Copyleft: For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:

1. You can use this source without any restriction for any desired purpose.
2. You can redistribute copies of this source to everybody.
3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
4. But the LPGL ist not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but don't need to publish the whole source of the own product.
5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.

If you are intent to use this sources without publishing its usage, you can get a second license subscribing a special contract with the author.

See Also:

Constant Field Values

name

private final java.lang.String name

The name is private because it is only used for toString().

nullSource

public static EventSource nullSource

A default source with empty methods.

Constructor Detail

EventSource

public EventSource(java.lang.String name)

Parameters:

name -

Method Detail

notifyDequeued

public void notifyDequeued()

It is called if the event is dequeued from the EventWithDst.evDstThread queue and attempt to processed.

notifyConsumed

public void notifyConsumed(int state)

This operation is called after calling EventConsumer.processEvent(java.util.EventObject) in EventTimerThread and should be called also in all other implementations of EventThread_ifc to assign, how the event is used.

Parameters:

state - The return value on EventConsumer.processEvent(java.util.EventObject) given from the user implementation. It is recommended to use the defined bits in EventConsumer.mEventConsumed etc. or also from StateSimple.mStateEntered etc. The bits 31..24 the EventWithDst.ctConsumed especially for debugging.

notifyRelinquished

public void notifyRelinquished(int ctConsumed)

notifyShouldSentButInUse

public void notifyShouldSentButInUse()

notifyShouldOccupyButInUse

public void notifyShouldOccupyButInUse()

notifyUnexpectedException

public void notifyUnexpectedException(java.lang.CharSequence msg)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object