org.electrocodeogram.cpc.core.api.hub.event
Class EclipseEditorPartEvent

java.lang.Object
  org.electrocodeogram.cpc.core.api.hub.event.CPCEvent
      org.electrocodeogram.cpc.core.api.hub.event.EclipseEvent
          org.electrocodeogram.cpc.core.api.hub.event.EclipseEditorPartEvent

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable<CPCEvent>

public class EclipseEditorPartEvent
extends EclipseEvent

This event is generated by the CPC Sensor module, whenever a file is opened or closed in an editor or when an editor window gains or looses the input focus.
The event only contains information about the type of event.

Author:

vw

Nested Class Summary

static class

EclipseEditorPartEvent.Type The type of an EclipseEditorPartEvent.

Field Summary

protected EclipseEditorPartEvent.Type

type

Fields inherited from class org.electrocodeogram.cpc.core.api.hub.event.EclipseEvent

fileLocatedInWorkspace, fileLocatedInWorkspaceCached, filePath, project, supportedFile, supportedFileCached, user

Constructor Summary

EclipseEditorPartEvent(java.lang.String user, java.lang.String project)
Creates a new EclipseEditorPartEvent for the given user and project.

Method Summary

EclipseEditorPartEvent.Type	getType() Retrieves the type of this event.
boolean	isValid() Checks if this event has been fully initialised.
void	setType(EclipseEditorPartEvent.Type type) Sets the type of this event.
java.lang.String	toString() Every event should implement a sensible toString method for use in debugging log messages.

Methods inherited from class org.electrocodeogram.cpc.core.api.hub.event.EclipseEvent

getFilePath, getProject, getUser, isFileLocatedInWorkspace, isSupportedFile, setFilePath, subToString

Methods inherited from class org.electrocodeogram.cpc.core.api.hub.event.CPCEvent

checkSeal, clone, compareTo, getCreationTime, seal

Methods inherited from class java.lang.Object

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

Field Detail

type

protected EclipseEditorPartEvent.Type type

Constructor Detail

EclipseEditorPartEvent

public EclipseEditorPartEvent(java.lang.String user,
                              java.lang.String project)

Creates a new EclipseEditorPartEvent for the given user and project.

Parameters:

user - the current user, never null.

project - the project for the file affected by this event, never null.

Method Detail

getType

public EclipseEditorPartEvent.Type getType()

Retrieves the type of this event.

Returns:

the type of this editor part event, never null.

setType

public void setType(EclipseEditorPartEvent.Type type)

Sets the type of this event.

This is a required value.

Parameters:

type - the type of this editor part event, never null.

isValid

public boolean isValid()

Description copied from class: CPCEvent

Checks if this event has been fully initialised.
Will return false if one of the mandatory fields of the event has not yet been filled out.

Subclasses should override this method but should never return true. Instead they should delegate to the super class implementation once all validity checks on their level have passed.

The CPCEvent.isValid() implementation always returns true.

Overrides:

isValid in class EclipseEvent

Returns:

true if this event is valid, false otherwise.

See Also:

IEventHubRegistry.dispatch(CPCEvent)

toString

public java.lang.String toString()

Description copied from class: CPCEvent

Every event should implement a sensible toString method for use in debugging log messages.

Specified by:

toString in class CPCEvent

Returns:

debug string representation, never null.