de.uka.ilkd.key.util

Interface FileCollection

All Known Implementing Classes:

DirectoryFileCollection, JavaReduxFileCollection, ZipFileCollection

public interface FileCollection

This class encapsulates a collection of files which is arbitrarily organised. It is iterable and allows to open all files (not directories) during the iteration as streams. Subclasses allow to iterate a jar/zip-file or a directory. Typical usage:

   FileCollection fc = ... ;
   FileCollection.Walker walker = fc.createWalker(".java");
   while(walker.step()) {
      // use the data of current location via walker.getCurrent...()
   }
 

Author:

MU

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FileCollection.Walker A Walker allows to iterate (once and one way) through a FileCollection.

Method Summary

Modifier and Type	Method and Description
FileCollection.Walker	createWalker(java.lang.String extension) create a FileCollection.Walker object that allows to iterate the file collection.
FileCollection.Walker	createWalker(java.lang.String[] extensions) create a FileCollection.Walker object that allows to iterate the file collection.

Method Detail

createWalker

FileCollection.Walker createWalker(java.lang.String extension)
                            throws java.io.IOException

create a FileCollection.Walker object that allows to iterate the file collection. The search can be restricted to files with a certain extension. If this is not desired, one specifies null for the extension.

Parameters:

extension - file extension to be considered only. null if all files are to be considered.

Returns:

a freshly created walker

Throws:

java.io.IOException - during opening resources

createWalker

FileCollection.Walker createWalker(java.lang.String[] extensions)
                            throws java.io.IOException

create a FileCollection.Walker object that allows to iterate the file collection. The search can be restricted to files with a certain extension. If this is not desired, one specifies null for the extension.

Parameters:

extensions - file extensions to be considered only. null if all files are to be considered.

Returns:

a freshly created walker

Throws:

java.io.IOException - during opening resources