igpp.util

Class Listing

java.lang.Object

igpp.util.Listing

public class Listing
extends java.lang.Object

Simple file and directory listing utility methods.

Version:

1.00 2009

Author:

Todd King

Constructor Summary

Constructors

Constructor and Description
Listing()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	exists(java.io.File root, java.lang.String pathName) Determine if a file or folder exists at the location of a File object.
static java.io.File	getFile(java.io.File root, java.lang.String pathName) Get the File object file or folder with a given name located at the location of a File object.
static java.io.File[]	getFileList(java.io.File root) Get the list of files located at the location specified with File object.
static java.io.File[]	getFileList(java.io.File root, java.lang.String pattern) Get the list of files located at the location specified with File object.
static java.io.File[]	getFileList(java.lang.String pathName) Get the list of files at the current path.
static java.io.File[]	getFileList(java.lang.String pathName, java.lang.String pattern) Get the list of files at the current path that match a particular pattern.
static java.io.File[]	getFileListByExtension(java.io.File root, java.lang.String extension) Get the list of files at the current path that have a particular filename extension.
static java.io.File[]	getFileListByExtension(java.lang.String pathName, java.lang.String extension) Get the list of files at the current path that have a particular filename extension.
static java.io.File	getFirstFile(java.io.File root) Get the first file in the sorted file list at the location specified with File object.
static java.io.File[]	getFolderList(java.io.File root) Get the list of folders located at the location specified with File object.
static java.io.File[]	getFolderList(java.lang.String pathName) Get the list of folders at the current path.
static java.io.File	getLastFile(java.io.File root) Get the last file in the sorted file list at the location specified with File object.
static java.io.File	getMostRecentFile(java.io.File root) Get the most recent file placed in at the location specified with File object.
static java.io.BufferedReader	getReader(java.io.File root, java.lang.String pathName) Obtain a BufferedReader for a file at the location of a File object.
static java.io.BufferedReader	getReader(java.lang.String pathName) Obtain a BufferedReader for pathname string.
static java.io.File[]	getSortedList(java.io.File[] list, int sortOn) Sort an array of File items based on an attribute of each file.
static java.io.File[]	getSortedList(java.io.File[] list, int sortOn, int direction) Sort an array of File items based on an attribute of each file.
static void	main(java.lang.String[] args)

Methods inherited from class java.lang.Object

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

Constructor Detail

Listing

public Listing()

Method Detail

main

public static void main(java.lang.String[] args)

getFolderList

public static java.io.File[] getFolderList(java.lang.String pathName)

Get the list of folders at the current path.

Returns:

Array of File items for each folder, null if no folders are present.

getFolderList

public static java.io.File[] getFolderList(java.io.File root)

Get the list of folders located at the location specified with File object.

Returns:

Array of File items for each folder, null if no folders are present.

getFileList

public static java.io.File[] getFileList(java.lang.String pathName)

Get the list of files at the current path.

Returns:

Array of File items for each file, null if no files are present.

getFileListByExtension

public static java.io.File[] getFileListByExtension(java.lang.String pathName,
                                    java.lang.String extension)

Get the list of files at the current path that have a particular filename extension. The comparision is case insensitive.

Returns:

Array of File items for each file, null if no files are present.

getFileListByExtension

public static java.io.File[] getFileListByExtension(java.io.File root,
                                    java.lang.String extension)

Get the list of files at the current path that have a particular filename extension. The comparision is case insensitive.

Returns:

Array of File items for each file, null if no files are present.

getFileList

public static java.io.File[] getFileList(java.lang.String pathName,
                         java.lang.String pattern)

Get the list of files at the current path that match a particular pattern. The pattern is expressed using regular expressions.

Returns:

Array of File items for each file, null if no files are present.

getFileList

public static java.io.File[] getFileList(java.io.File root,
                         java.lang.String pattern)

Get the list of files located at the location specified with File object.

Returns:

Array of File items for each file, null if no files are present.

getFileList

public static java.io.File[] getFileList(java.io.File root)

Get the list of files located at the location specified with File object.

Returns:

Array of File items for each file, null if no files are present.

getMostRecentFile

public static java.io.File getMostRecentFile(java.io.File root)

Get the most recent file placed in at the location specified with File object.

Returns:

Array of File items for each file, null if no files are present.

getFirstFile

public static java.io.File getFirstFile(java.io.File root)

Get the first file in the sorted file list at the location specified with File object.

Returns:

Array of File items for each file, null if no files are present.

getLastFile

public static java.io.File getLastFile(java.io.File root)

Get the last file in the sorted file list at the location specified with File object.

Returns:

Array of File items for each file, null if no files are present.

getFile

public static java.io.File getFile(java.io.File root,
                   java.lang.String pathName)

Get the File object file or folder with a given name located at the location of a File object.

Returns:

File pointing to the desired file, otherwise null.

exists

public static boolean exists(java.io.File root,
             java.lang.String pathName)

Determine if a file or folder exists at the location of a File object.

Returns:

true if

getSortedList

public static java.io.File[] getSortedList(java.io.File[] list,
                           int sortOn,
                           int direction)

Sort an array of File items based on an attribute of each file. FileComparator for a list of allowed values for sortOn and direction.

Returns:

Array of File items for each file, null if no folders are present.

getSortedList

public static java.io.File[] getSortedList(java.io.File[] list,
                           int sortOn)

Sort an array of File items based on an attribute of each file. List is sorted in ascending order. FileComparator for a list of allowed values for sortOn.

Returns:

Array of File items for each file, null if no folders are present.

getReader

public static java.io.BufferedReader getReader(java.io.File root,
                               java.lang.String pathName)

Obtain a BufferedReader for a file at the location of a File object.

Returns:

A new instance of a BufferedReader if file exists, otherwise null.

getReader

public static java.io.BufferedReader getReader(java.lang.String pathName)

Obtain a BufferedReader for pathname string.

Returns:

A new instance of a BufferedReader if file exists, otherwise null.