org.incava.ijdk.lang

Class Pathname

java.lang.Object

java.io.File

org.incava.ijdk.lang.Pathname

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<java.io.File>

public class Pathname
extends java.io.File

Extends java.io.File with Ruby-ish functionality, based on pathname.rb. The main differences are: - pathnames can be specified by relative paths, which can be accessed (via relativePath()) - fewer checked exceptions - clearer method names: relativePath(), fullPath(), baseName(), rootName(), extension()

See Also:

Serialized Form

Field Summary

Fields inherited from class java.io.File

pathSeparator, pathSeparatorChar, separator, separatorChar

Constructor Summary

Constructors

Constructor and Description
Pathname() Creates a Pathname from the current directory (user.dir).
Pathname(java.io.File file) Creates a Pathname from a file, using its relative -- not absolute or canonical -- path.
Pathname(java.lang.String pathName) Creates a Pathname from a pathname.

Method Summary

Modifier and Type	Method and Description
java.lang.String	baseName() Returns the base name (same as File#getName()).
java.util.List<Pathname>	children() Returns the immediate subelements of this pathname.
java.lang.String	expandPath() Returns the path, fully expanded, i.e., resolved within the file system.
java.lang.String	extension() Returns the extension, the segment trailing the final dot, or null if there is no dot in the basename.
java.io.File	file()
static java.util.List<Pathname>	findAll()
static java.util.List<Pathname>	glob(java.lang.String glob)
Pathname	parent() Returns the parent directory as a pathname, as a relative path.
void	printLines(java.util.List<java.lang.String> lines) Writes the lines to the file.
byte[]	readBytes() Reads the file as an array of bytes.
java.util.List<java.lang.String>	readLines() Reads the file, returning a list of lines, which do not include end of line characters.
java.lang.String	relativePath() Returns the relative -- not absolute or canonical -- path.
java.lang.String	rootName() Returns the root name, which is the base name minus the (last) extension.

Methods inherited from class java.io.File

canExecute, canRead, canWrite, compareTo, createNewFile, createTempFile, createTempFile, delete, deleteOnExit, equals, exists, getAbsoluteFile, getAbsolutePath, getCanonicalFile, getCanonicalPath, getFreeSpace, getName, getParent, getParentFile, getPath, getTotalSpace, getUsableSpace, hashCode, isAbsolute, isDirectory, isFile, isHidden, lastModified, length, list, list, listFiles, listFiles, listFiles, listRoots, mkdir, mkdirs, renameTo, setExecutable, setExecutable, setLastModified, setReadable, setReadable, setReadOnly, setWritable, setWritable, toPath, toString, toURI, toURL

Methods inherited from class java.lang.Object

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

Constructor Detail

Pathname

public Pathname(java.io.File file)

Creates a Pathname from a file, using its relative -- not absolute or canonical -- path.

Pathname

public Pathname(java.lang.String pathName)

Creates a Pathname from a pathname.

Pathname

public Pathname()

Creates a Pathname from the current directory (user.dir).

Method Detail

glob

public static java.util.List<Pathname> glob(java.lang.String glob)

findAll

public static java.util.List<Pathname> findAll()

relativePath

public java.lang.String relativePath()

Returns the relative -- not absolute or canonical -- path.

     new Pathname("abc/def.txt").relativePath(); // == "abc/def.txt"
 

baseName

public java.lang.String baseName()

Returns the base name (same as File#getName()).

     new Pathname("abc/def.txt").baseName();     // == "def.txt"
 

extension

public java.lang.String extension()

Returns the extension, the segment trailing the final dot, or null if there is no dot in the basename.

     new Pathname("abc/def.txt").extension();    // == "txt"
     new Pathname("abc/def.tar.gz").extension(); // == "gz"
     new Pathname("abc/def.").extension();       // == ""
     new Pathname("abc/def").extension();        // == null
 

rootName

public java.lang.String rootName()

Returns the root name, which is the base name minus the (last) extension. If there is no extension, then the root name is the same as the base name.

     new Pathname("abc/def.txt").rootName();     // == "def"
     new Pathname("abc/def.tar.gz").rootName();  // == "def.tar"
 

file

public java.io.File file()

parent

public Pathname parent()

Returns the parent directory as a pathname, as a relative path. The parent directory of a file is the directory of that file, so if the relative path refers to a file in the current directory (new Pathname("a")), then its "parent" directory is the current directory (new Pathname(".") ). All parents continue to be relative, i.e., of the form "../../..", even if that would resolve to the root (or above) of the current file system.

     new Pathname("a/b").parent();                 // == "a"
     new Pathname("b").parent();                   // == "."
     new Pathname("b").parent().parent();          // == ".."
     new Pathname("b").parent().parent().parent(); // == "../.."
 

expandPath

public java.lang.String expandPath()

Returns the path, fully expanded, i.e., resolved within the file system. If the path is relative (e.g., "lib/foo.rb"), then it will be resolved against the current directory. If the path is absolute ("/usr/local/bin/irb"), then it is returned. This currently does not resolve intermediate elements, such as "." and "..", and it may in the future.

readLines

public java.util.List<java.lang.String> readLines()

Reads the file, returning a list of lines, which do not include end of line characters.

readBytes

public byte[] readBytes()

Reads the file as an array of bytes.

printLines

public void printLines(java.util.List<java.lang.String> lines)

Writes the lines to the file.

Parameters:

lines - the lines to print

children

public java.util.List<Pathname> children()

Returns the immediate subelements of this pathname.