com.cisco.provisioning.cpe.events
Class FileEventQualifier

java.lang.Object
  extended by com.cisco.provisioning.cpe.events.Qualifier
      extended by com.cisco.provisioning.cpe.events.FileEventQualifier
All Implemented Interfaces:
Externalizable, Serializable

public class FileEventQualifier
extends Qualifier

This implementation of the Qualifier class is to be used with the FileEvent.

See Also:
Serialized Form

Constructor Summary
FileEventQualifier()
          This constructor is needed for externalization Note: This constructor is ONLY used for externalization.
 
Method Summary
 void clearAll()
          Clears all qualification options that have been set.
 void clearIsDeliverable()
          Clears the isDeliverable check.
 boolean qualifies(ProvAPIEvent event)
          Returns true if the implementation has determined that this event satisfies the requirements to notify the associated listener.
 void readExternal(ObjectInput in)
          Externalizable interface.
 void setChangedProperties()
          Sets the qualifier method to return true to all FileEvents that are FileListener.CHANGED_PROPERTIES sub-events.
 void setDeletedFile()
          Sets the qualifier method to return true to all FileEvents that are FileListener.DELETE_FILE sub-events.
 void setIsDeliverable(boolean isDeliverable)
          Sets the qualifer method to return all files that match the given isDeliverable value.
 void setNewFile()
          Sets the qualifier method to return true to all FileEvents that are FileListener.ADD_FILE sub-events.
 void setReplaceFile()
          Sets the qualifier method to return true to all FileEvents that are FileListener.REPLACE_FILE sub-events.
 void writeExternal(ObjectOutput out)
          Externalizable interface.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FileEventQualifier

public FileEventQualifier()
This constructor is needed for externalization

Note: This constructor is ONLY used for externalization.

Method Detail

clearAll

public void clearAll()
Clears all qualification options that have been set.


qualifies

public boolean qualifies(ProvAPIEvent event)
Returns true if the implementation has determined that this event satisfies the requirements to notify the associated listener.

Specified by:
qualifies in class Qualifier
Parameters:
event - the object representing the event has occurred.

Returns:
true if the implementation has determined that this event satisfies the requirements to notify the associated listener.

setNewFile

public void setNewFile()
Sets the qualifier method to return true to all FileEvents that are FileListener.ADD_FILE sub-events.


setDeletedFile

public void setDeletedFile()
Sets the qualifier method to return true to all FileEvents that are FileListener.DELETE_FILE sub-events.


setReplaceFile

public void setReplaceFile()
Sets the qualifier method to return true to all FileEvents that are FileListener.REPLACE_FILE sub-events.


setChangedProperties

public void setChangedProperties()
Sets the qualifier method to return true to all FileEvents that are FileListener.CHANGED_PROPERTIES sub-events.


clearIsDeliverable

public void clearIsDeliverable()
Clears the isDeliverable check.


setIsDeliverable

public void setIsDeliverable(boolean isDeliverable)
Sets the qualifer method to return all files that match the given isDeliverable value.

Parameters:
isDeliverable - the value to filter FileEvents on.

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Externalizable interface. The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays. The readExternal method must read the values in the same sequence and with the same types as were written by writeExternal.

Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class Qualifier
Parameters:
in - the stream to read data from in order to restore the object

Throws:
IOException - if I/O errors occur
ClassNotFoundException - If the class for an object being restored cannot be found.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Externalizable interface. The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.

Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class Qualifier
Parameters:
out - the stream to write the object to

Throws:
IOException - Includes any I/O exceptions that may occur