com.cisco.provisioning.cpe.events
Class FileAdapter

java.lang.Object
  extended by com.cisco.provisioning.cpe.events.FileAdapter
All Implemented Interfaces:
FileListener, ProvAPIEventListener

public abstract class FileAdapter
extends Object
implements FileListener

An abstract class that provides no-op definitions of all methods in the FileListener interface. Users must extend this class, and then implement the methods for the desired FileEvent sub-event notifications.


Field Summary
 
Fields inherited from interface com.cisco.provisioning.cpe.events.FileListener
ADD_FILE, CHANGED_PROPERTIES, DELETE_FILE, REPLACE_FILE
 
Constructor Summary
FileAdapter()
           
 
Method Summary
 void added(FileEvent ev)
          The method invoked when an FileEvent arrives when a new file is created.
 void deleted(FileEvent ev)
          The method invoked when an FileEvent arrives when a file is deleted.
 boolean getOneShot()
          Gets oneShot mode value, specifying whether or not the listener is registered for just one occurrence of the Event.
 void propertiesChanged(FileEvent ev)
          The method invoked when an FileEvent arrives when a file is changeproperties.
 void replaced(FileEvent ev)
          The method invoked when an FileEvent arrives when a file is replaced.
 void setOneShot(boolean flg)
          Sets oneShot mode, specifying that the registration request is for just one occurrence of the Event.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FileAdapter

public FileAdapter()
Method Detail

added

public void added(FileEvent ev)
The method invoked when an FileEvent arrives when a new file is created.

Specified by:
added in interface FileListener
Parameters:
ev - The object containing the FileEvent data.

replaced

public void replaced(FileEvent ev)
The method invoked when an FileEvent arrives when a file is replaced.

Specified by:
replaced in interface FileListener
Parameters:
ev - The object containing the FileEvent data.

deleted

public void deleted(FileEvent ev)
The method invoked when an FileEvent arrives when a file is deleted.

Specified by:
deleted in interface FileListener
Parameters:
ev - The object containing the FileEvent data.

propertiesChanged

public void propertiesChanged(FileEvent ev)
The method invoked when an FileEvent arrives when a file is changeproperties.

Specified by:
propertiesChanged in interface FileListener
Parameters:
ev - The object containing the FileEvent data.

getOneShot

public boolean getOneShot()
Gets oneShot mode value, specifying whether or not the listener is registered for just one occurrence of the Event.

Specified by:
getOneShot in interface ProvAPIEventListener
Returns:
true if oneShot mode has been set

setOneShot

public void setOneShot(boolean flg)
Sets oneShot mode, specifying that the registration request is for just one occurrence of the Event.

Specified by:
setOneShot in interface ProvAPIEventListener
Parameters:
flg - true if oneShot mode is being set