org.opensolaris.opengrok.web

Class DirectoryListing

java.lang.Object

org.opensolaris.opengrok.web.DirectoryListing

public class DirectoryListing
extends java.lang.Object

Generates HTML listing of a Directory

Constructor Summary

Constructors

Constructor and Description
DirectoryListing()
DirectoryListing(EftarFileReader desc)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<java.lang.String>	listTo(java.io.File dir, java.io.Writer out, java.lang.String path, java.util.List<java.lang.String> files) Write a htmlized listing of the given directory to the given destination.

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectoryListing

public DirectoryListing()

DirectoryListing

public DirectoryListing(EftarFileReader desc)

Method Detail

listTo

public java.util.List<java.lang.String> listTo(java.io.File dir,
                                      java.io.Writer out,
                                      java.lang.String path,
                                      java.util.List<java.lang.String> files)
                                        throws java.io.IOException

Write a htmlized listing of the given directory to the given destination.

Parameters:

dir - the directory to list

out - write destination

path - virtual path of the directory (usually the path name of dir with the opengrok source directory stripped off).

files - basenames of potential children of the directory to list. Gets filtered by IgnoredNames.

Returns:

a possible empty list of README files included in the written listing.

Throws:

java.io.IOException

java.lang.NullPointerException - if a parameter except files is null