com.starteam.events
Class CommandProcessorCheckinEvent

java.lang.Object
  java.util.EventObject
      com.starteam.events.CommandProcessorCheckinEvent

All Implemented Interfaces:

java.io.Serializable

public final class CommandProcessorCheckinEvent
extends java.util.EventObject

An event triggered whenever an add or a checkin operation is executed through the CommandProcessor The event is fired (per file) before the add or checkin transaction begins, and allows the client application to skip the operation for that file for any reason whatsoever The event is also fired (per file) for informational purposes after the transaction completes

See Also:

Serialized Form

Method Summary

File	getFile() Returns the file that is being added/checked in
boolean	isSkipped() return true if this file should be skipped during execution The default behavior is to not skip files being added or checked in
void	skip() skip this file during execution of the command Set the file to be skipped when the event first fires for this file; (i.e.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Method Detail

getFile

public File getFile()

Returns the file that is being added/checked in

isSkipped

public boolean isSkipped()

return true if this file should be skipped during execution The default behavior is to not skip files being added or checked in

Returns:

true if this file should be skipped during execution

skip

public void skip()

skip this file during execution of the command Set the file to be skipped when the event first fires for this file; (i.e. before the add or checkin has occurred) The value of this property is ignored after the file is added or checked into the repository Note that add and checkin are transactional operations, so these events will fire in sequence for all files before the transaction is started, and will fire in sequence again for all files after the transaction has been completed