org.compass.core.config.binding.scanner
Class FileScanner

java.lang.Object
  org.compass.core.config.binding.scanner.FileScanner

All Implemented Interfaces:

Scanner

public class FileScanner
extends Object
implements Scanner

A scanner that works either on a file or a directory. Handles the "file" protocol.

Author:

kimchy

Constructor Summary

FileScanner(String basePackge, File file, Filter filter)

Method Summary

void	close() Cleanup any open resources of the iterator
protected void	create(List<File> list, File dir, Filter filter)
ScanItem	next() User is resposible for closing the InputStream returned

Methods inherited from class java.lang.Object

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

Constructor Detail

FileScanner

public FileScanner(String basePackge,
                   File file,
                   Filter filter)

Method Detail

create

protected void create(List<File> list,
                      File dir,
                      Filter filter)
               throws Exception

Throws:

Exception

next

public ScanItem next()

Description copied from interface: Scanner

User is resposible for closing the InputStream returned

Specified by:

next in interface Scanner

Returns:

null if no more streams left to iterate on

close

public void close()

Description copied from interface: Scanner

Cleanup any open resources of the iterator

Specified by:

close in interface Scanner