org.kepler.io

Class DirectoryListing

java.lang.Object

org.kepler.io.DirectoryListing

public class DirectoryListing
extends java.lang.Object

Get the actual list of files in a directory and provide a difference from the previous listing. Do the listing either on a local dir with Java or on a remote machine using SSH. Do the listing with a set of patterns. For each file, provide its - name, - size (in bytes) - date (in UTC seconds)

Constructor Summary

Constructors

Constructor and Description
DirectoryListing(java.io.File directory, java.lang.String[] filemasks) Constructor only for local directories.
DirectoryListing(java.lang.String target, java.lang.String directory, java.lang.String[] filemasks) Constructor for remote or local directories.

Method Summary

Modifier and Type	Method and Description
FileInfo[]	getList() Get the list itself.
FileInfo[]	getNewFiles(boolean checkModifications) Get the list of 'new' files, i.e. that are in currentList and not in prevList.
int	list() Kept for compatibility with older codes.
int	list(boolean useLsOnly) List the directory now.
void	setMask(java.lang.String[] filemasks) (Re)set the file mask.

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectoryListing

public DirectoryListing(java.io.File directory,
                        java.lang.String[] filemasks)
                 throws java.lang.IllegalArgumentException

Constructor only for local directories. Throws IllegalArgumentException if local directory does not exist.

Throws:

java.lang.IllegalArgumentException

DirectoryListing

public DirectoryListing(java.lang.String target,
                        java.lang.String directory,
                        java.lang.String[] filemasks)
                 throws java.lang.IllegalArgumentException

Constructor for remote or local directories. For local machine, specify target as null, "", or "local"

Throws:

java.lang.IllegalArgumentException

Method Detail

setMask

public void setMask(java.lang.String[] filemasks)

(Re)set the file mask. This can be reset before any listing. Previous listing will be forgotten.

list

public int list()
         throws ExecException

Kept for compatibility with older codes.

Throws:

ExecException

list

public int list(boolean useLsOnly)
         throws ExecException

List the directory now. Returns the number of files, -1 on error; Input: useLsOnly: false -> execute 'ls -l' on remote machine

Throws:

ExecException

getList

public FileInfo[] getList()

Get the list itself.

getNewFiles

public FileInfo[] getNewFiles(boolean checkModifications)

Get the list of 'new' files, i.e. that are in currentList and not in prevList. If parameter 'checkModifications' is false, the difference between currentList and prevList will be based on the file names only. If it is true, files' date and size is also checked, i.e. modified files will also be retruned.

Returns:

FileInfo[] of filenames