Package edu.wisc.library.ocfl.core.storage.common

Class Listing

java.lang.Object

edu.wisc.library.ocfl.core.storage.common.Listing

public class Listing
extends Object

The result of a storage list operation

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Listing.Type

Constructor Summary

Constructors

Constructor	Description
Listing(Listing.Type type, String relativePath)

Method Summary

Modifier and Type	Method	Description
static Listing	directory(String relativePath)	Creates a directory listing.
boolean	equals(Object o)
static Listing	file(String relativePath)	Creates a file listing.
String	getRelativePath()
Listing.Type	getType()
int	hashCode()
boolean	isDirectory()
boolean	isFile()
boolean	isOther()
static Listing	other(String relativePath)	Creates a listing for a file that is neither a regular file nor directory, such as a symbolic link.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Listing

public Listing(Listing.Type type,
               String relativePath)

Method Detail

file

public static Listing file(String relativePath)

Creates a file listing. The path MUST use forward slashes as path separators.

Parameters:

relativePath - relative path to the file

Returns:

file listing

directory

public static Listing directory(String relativePath)

Creates a directory listing. The path MUST use forward slashes as path separators.

Parameters:

relativePath - relative path to the directory

Returns:

directory listing

other

public static Listing other(String relativePath)

Creates a listing for a file that is neither a regular file nor directory, such as a symbolic link. The path MUST use forward slashes as path separators.

Parameters:

relativePath - relative path to the file

Returns:

file listing

getRelativePath

public String getRelativePath()

Returns:

the path to the file/directory relative the list operation path

getType

public Listing.Type getType()

Returns:

the type of file

isFile

public boolean isFile()

isDirectory

public boolean isDirectory()

isOther

public boolean isOther()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object