All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.archiveaccessor.filestore.FileBucketAccessor

java.lang.Object
   |
   +----com.ibm.archiveaccessor.filestore.FileBucketAccessor

public abstract class FileBucketAccessor
extends Object
implements Cloneable, Serializable
The FileBucketAccessor is the generic class that introduces functionality of a bean that implements access to a bucket of files.


Constructor Index

 o FileBucketAccessor()
Constructor.

Method Index

 o add(String)
Adds a file to a file bucket
 o addPropertyChangeListener(PropertyChangeListener)
Registers a new listener of the PropertyChanged event.
 o clear()
Removes all files from a file bucket
 o close()
Closes a file bucket
 o contents()
Gets contents of a file bucket.
 o contentsAsEnumeration()
Gets contents of a file bucket as an enumeration.
 o create()
Prepares a new file bucket
 o create(String)
Creates a new file bucket from an existed one.
 o exists(String)
Checks if the specified file name is present in the bucket.
 o getExceptionMessage(String)
Gets a bean's exception message by message id.
 o getName()
Gets a name of a file bucket
 o isAutomaticSave()
Returns the switch that indicates whether the file bucket is automatically saved when it is closing or no.
 o open(String)
Opens a file bucket
 o remove(String)
Removes a file from a file bucket
 o removePropertyChangeListener(PropertyChangeListener)
Removes a listener of the PropertyChanged event.
 o rename(String, String)
Renames a file in a file bucket
 o replace(String)
Replaces a file in a file bucket
 o save()
Saves a file bucket
 o saveAs(String)
Saves a file bucket with another name
 o setAutomaticSave(boolean)
Turns on/off the switch that indicates whether the file bucket is automatically saved when it is closing or no.
 o setName(String)
Sets the name of a file bucket.

Constructors

 o FileBucketAccessor
 public FileBucketAccessor()
Constructor.

Methods

 o setName
 public void setName(String aName) throws IllegalArgumentException
Sets the name of a file bucket. Fires property change event if the name of a file bucket is actually changing.

Parameters:
aName - the name of the file bucket.
Throws: IllegalArgumentException
may be thrown when the name is null.
 o getName
 public String getName()
Gets a name of a file bucket

 o setAutomaticSave
 public void setAutomaticSave(boolean aSwitch)
Turns on/off the switch that indicates whether the file bucket is automatically saved when it is closing or no. Fires property change event if the switch of automatic saving is actually changing.

Parameters:
aSwitch - true or false.
 o isAutomaticSave
 public boolean isAutomaticSave()
Returns the switch that indicates whether the file bucket is automatically saved when it is closing or no.

 o addPropertyChangeListener
 public void addPropertyChangeListener(PropertyChangeListener aListener) throws IllegalArgumentException
Registers a new listener of the PropertyChanged event.

Parameters:
aListener - an object to be registered as a listener of the PropertyChanged event.
Throws: IllegalArgumentException
may be thrown when the listener object is null.
 o removePropertyChangeListener
 public void removePropertyChangeListener(PropertyChangeListener aListener) throws IllegalArgumentException
Removes a listener of the PropertyChanged event.

Parameters:
aListener - the object to be removed as a listener of the PropertyChanged event.
Throws: IllegalArgumentException
may be thrown when the listener object is null.
 o open
 public abstract void open(String aFileName) throws FileBucketAccessorException
Opens a file bucket

Throws: FileBucketAccessorException
may be thrown
 o create
 public abstract void create() throws FileBucketAccessorException
Prepares a new file bucket

Throws: FileBucketAccessorException
may be thrown
 o create
 public abstract void create(String aFileName) throws FileBucketAccessorException
Creates a new file bucket from an existed one.

Parameters:
aFileName - the name of an existing archive file.
Throws: FileBucketAccessorException
may be thrown
 o close
 public abstract void close() throws FileBucketAccessorException
Closes a file bucket

Throws: FileBucketAccessorException
may be thrown
 o add
 public abstract void add(String aFile) throws FileBucketAccessorException
Adds a file to a file bucket

Throws: FileBucketAccessorException
may be thrown
 o replace
 public abstract void replace(String aFile) throws FileBucketAccessorException
Replaces a file in a file bucket

Throws: FileBucketAccessorException
may be thrown
 o remove
 public abstract void remove(String aFile) throws FileBucketAccessorException
Removes a file from a file bucket

Throws: FileBucketAccessorException
may be thrown
 o clear
 public abstract void clear() throws FileBucketAccessorException
Removes all files from a file bucket

Throws: FileBucketAccessorException
may be thrown
 o rename
 public abstract void rename(String anOldName,
                             String aNewName) throws FileBucketAccessorException
Renames a file in a file bucket

Throws: FileBucketAccessorException
may be thrown
 o exists
 public abstract boolean exists(String aFile) throws FileBucketAccessorException
Checks if the specified file name is present in the bucket.

Parameters:
aFile - the name of a file to be checked in the bucket.
Throws: FileBucketAccessorException
may be thrown
 o contents
 public abstract String[] contents() throws FileBucketAccessorException
Gets contents of a file bucket.

Throws: FileBucketAccessorException
may be thrown
 o contentsAsEnumeration
 public abstract Enumeration contentsAsEnumeration() throws FileBucketAccessorException
Gets contents of a file bucket as an enumeration.

Throws: FileBucketAccessorException
may be thrown
 o save
 public abstract void save() throws FileBucketAccessorException
Saves a file bucket

Throws: FileBucketAccessorException
may be thrown
 o saveAs
 public void saveAs(String aName) throws FileBucketAccessorException
Saves a file bucket with another name

Throws: FileBucketAccessorException
may be thrown
 o getExceptionMessage
 public static String getExceptionMessage(String anId)
Gets a bean's exception message by message id.

Parameters:
anId - id of an exception message.

All Packages  Class Hierarchy  This Package  Previous  Next  Index