Package org.apache.hadoop.fs.shell

Class PathData

java.lang.Object

org.apache.hadoop.fs.shell.PathData

All Implemented Interfaces:

java.lang.Comparable<PathData>

@Private
@Unstable
public class PathData
extends java.lang.Object
implements java.lang.Comparable<PathData>

Encapsulates a Path (path), its FileStatus (stat), and its FileSystem (fs). PathData ensures that the returned path string will be the same as the one passed in during initialization (unlike Path objects which can modify the path string). The stat field will be null if the path does not exist.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	PathData.FileTypeRequirement
protected static class	PathData.PathType

Field Summary

Fields

Modifier and Type	Field	Description
boolean	exists
FileSystem	fs
Path	path
FileStatus	stat
protected java.net.URI	uri

Constructor Summary

Constructors

Constructor	Description
PathData(java.lang.String pathString, Configuration conf)	Creates an object to wrap the given parameters as fields.
PathData(java.net.URI localPath, Configuration conf)	Creates an object to wrap the given parameters as fields.

Method Summary

Modifier and Type	Method	Description
int	compareTo(PathData o)
boolean	equals(java.lang.Object o)
static PathData[]	expandAsGlob(java.lang.String pattern, Configuration conf)	Expand the given path as a glob pattern.
PathData[]	getDirectoryContents()	Returns a list of PathData objects of the items contained in the given directory.
RemoteIterator<PathData>	getDirectoryContentsIterator()	Returns a RemoteIterator for PathData objects of the items contained in the given directory.
PathData	getPathDataForChild(PathData child)	Creates a new object for a child entry in this directory
int	hashCode()
protected FSDataInputStream	openFile(java.lang.String policy)	Open a file.
protected FSDataInputStream	openForSequentialIO()	Open a file for sequential IO.
boolean	parentExists()	Test if the parent directory exists
FileStatus	refreshStatus()	Updates the paths's file status
boolean	representsDirectory()	Check if the path represents a directory as determined by the basename being "." or "..", or the path ending with a directory separator
PathData	suffix(java.lang.String extension)	Returns a new PathData with the given extension.
java.io.File	toFile()	Get the path to a local file
java.lang.String	toString()	Returns the printable version of the path that is either the path as given on the commandline, or the full path

Methods inherited from class java.lang.Object

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

Field Detail

uri

protected final java.net.URI uri

fs

public final FileSystem fs

path

public final Path path

stat

public FileStatus stat

exists

public boolean exists

Constructor Detail

PathData

public PathData(java.lang.String pathString,
                Configuration conf)
         throws java.io.IOException

Creates an object to wrap the given parameters as fields. The string used to create the path will be recorded since the Path object does not return exactly the same string used to initialize it

Parameters:

pathString - a string for a path

conf - the configuration file

Throws:

java.io.IOException - if anything goes wrong...

PathData

public PathData(java.net.URI localPath,
                Configuration conf)
         throws java.io.IOException

Creates an object to wrap the given parameters as fields. The string used to create the path will be recorded since the Path object does not return exactly the same string used to initialize it

Parameters:

localPath - a local URI

conf - the configuration file

Throws:

java.io.IOException - if anything goes wrong...

Method Detail

refreshStatus

public FileStatus refreshStatus()
                         throws java.io.IOException

Updates the paths's file status

Returns:

the updated FileStatus

Throws:

java.io.IOException - if anything goes wrong...

suffix

public PathData suffix(java.lang.String extension)
                throws java.io.IOException

Returns a new PathData with the given extension.

Parameters:

extension - for the suffix

Returns:

PathData

Throws:

java.io.IOException - shouldn't happen

parentExists

public boolean parentExists()
                     throws java.io.IOException

Test if the parent directory exists

Returns:

boolean indicating parent exists

Throws:

java.io.IOException - upon unexpected error

representsDirectory

public boolean representsDirectory()

Check if the path represents a directory as determined by the basename being "." or "..", or the path ending with a directory separator

Returns:

boolean if this represents a directory

getDirectoryContents

public PathData[] getDirectoryContents()
                                throws java.io.IOException

Returns a list of PathData objects of the items contained in the given directory.

Returns:

list of PathData objects for its children

Throws:

java.io.IOException - if anything else goes wrong...

getDirectoryContentsIterator

public RemoteIterator<PathData> getDirectoryContentsIterator()
                                                      throws java.io.IOException

Returns a RemoteIterator for PathData objects of the items contained in the given directory.

Returns:

remote iterator of PathData objects for its children

Throws:

java.io.IOException - if anything else goes wrong...

getPathDataForChild

public PathData getPathDataForChild(PathData child)
                             throws java.io.IOException

Creates a new object for a child entry in this directory

Parameters:

child - the basename will be appended to this object's path

Returns:

PathData for the child

Throws:

java.io.IOException - if this object does not exist or is not a directory

expandAsGlob

public static PathData[] expandAsGlob(java.lang.String pattern,
                                      Configuration conf)
                               throws java.io.IOException

Expand the given path as a glob pattern. Non-existent paths do not throw an exception because creation commands like touch and mkdir need to create them. The "stat" field will be null if the path does not exist.

Parameters:

pattern - the pattern to expand as a glob

conf - the hadoop configuration

Returns:

list of PathData objects. if the pattern is not a glob, and does not exist, the list will contain a single PathData with a null stat

Throws:

java.io.IOException - anything else goes wrong...

toString

public java.lang.String toString()

Returns the printable version of the path that is either the path as given on the commandline, or the full path

Overrides:

toString in class java.lang.Object

Returns:

String of the path

toFile

public java.io.File toFile()

Get the path to a local file

Returns:

File representing the local path

Throws:

java.lang.IllegalArgumentException - if this.fs is not the LocalFileSystem

compareTo

public int compareTo(PathData o)

Specified by:

compareTo in interface java.lang.Comparable<PathData>

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

openForSequentialIO

protected FSDataInputStream openForSequentialIO()
                                         throws java.io.IOException

Open a file for sequential IO.

This uses FileSystem.openFile() to request sequential IO; the file status is also passed in. Filesystems may use to optimize their IO.

Returns:

an input stream

Throws:

java.io.IOException - failure

openFile

protected FSDataInputStream openFile(java.lang.String policy)
                              throws java.io.IOException

Open a file.

Parameters:

policy - fadvise policy.

Returns:

an input stream

Throws:

java.io.IOException - failure