net.sf.rubycollect4j

Class RubyFile

java.lang.Object

net.sf.rubycollect4j.RubyIO

net.sf.rubycollect4j.RubyFile

public final class RubyFile
extends RubyIO

RubyFile implements parts of the methods refer to the File class of Ruby.

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.rubycollect4j.RubyIO

RubyIO.Mode

Field Summary

Fields inherited from class net.sf.rubycollect4j.RubyIO

file, mode, raFile

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	absolutePath(java.lang.String path) Returns the absolute path of the file.
static java.lang.String	basename(java.lang.String path) Returns the name of the file.
static java.lang.String	basename(java.lang.String path, java.lang.String suffix) Returns the name of a file.
static int	chmod(int modeInt, java.lang.String... files) Changes the permission mode of files.
static int	delete(java.lang.String... files) Deletes all given files.
static boolean	directoryʔ(java.lang.String path) Checks if the file of the path is a directory.
static java.lang.String	dirname(java.lang.String path) Returns the parent folder of the file.
static boolean	executableʔ(java.lang.String path) Checks if a file is executable.
static boolean	existsʔ(java.lang.String path) Equivalent to existʔ(String).
static boolean	existʔ(java.lang.String path) Checks if a file existed.
static java.lang.String	expandPath(java.lang.String path) Returns the absolute path of the file.
static java.lang.String	expandPath(java.lang.String file, java.lang.String dir) Returns the expanded path by given paths.
static java.lang.String	extname(java.lang.String path) Returns the extension name of the file.
static boolean	fileʔ(java.lang.String path) Checks if path is a file.
static java.lang.String	join(java.lang.String... files) Returns a joined path by given files.
java.util.Date	mtime() Returns the last modified Data of the file.
static RubyFile	open(java.lang.String path) Creates a RubyFile by given file.
static RubyFile	open(java.lang.String path, java.lang.String mode) Creates a RubyFile by given path and mode.
java.lang.String	path() Returns the path of the file.
static boolean	readableʔ(java.lang.String path) Checks if a file is readable.
long	size() Returns the size of the file in bytes.
static long	size(java.lang.String path) Returns the size of a file.
static java.lang.Long	sizeʔ(java.lang.String path) Returns null if filedoesn’t exist or has 0 in length, the size of the file otherwise.
java.lang.String	toPath() Returns the path of the file.
java.lang.String	toString()
static boolean	writableʔ(java.lang.String path) Checks if a file is writable.
static boolean	zeroʔ(java.lang.String path) Checks if the file gets 0 length.

Methods inherited from class net.sf.rubycollect4j.RubyIO

close, eachLine, foreach, foreach, puts, read, seek, write

Methods inherited from class java.lang.Object

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

Method Detail

open

public static RubyFile open(java.lang.String path,
            java.lang.String mode)

Creates a RubyFile by given path and mode.

Parameters:

path - of a File

mode - r, rw, w, w+, a, a+

Returns:

RubyFile

open

public static RubyFile open(java.lang.String path)

Creates a RubyFile by given file. Sets the mode to read-only.

Parameters:

path - of a file

Returns:

RubyFile

absolutePath

public static java.lang.String absolutePath(java.lang.String path)

Returns the absolute path of the file.

Parameters:

path - of a file

Returns:

the absolute path of the file

basename

public static java.lang.String basename(java.lang.String path)

Returns the name of the file.

Parameters:

path - of a file

Returns:

the basename of the path

basename

public static java.lang.String basename(java.lang.String path,
                        java.lang.String suffix)

Returns the name of a file.

Parameters:

path - of a file

suffix - to be removed if it's at the end of the name

Returns:

the name of the file

chmod

public static int chmod(int modeInt,
        java.lang.String... files)

Changes the permission mode of files.

Parameters:

modeInt - permission

files - to be changed mode

Returns:

number of files changed

delete

public static int delete(java.lang.String... files)

Deletes all given files.

Parameters:

files - names of files

Returns:

the number of deleted files

directoryʔ

public static boolean directoryʔ(java.lang.String path)

Checks if the file of the path is a directory.

Parameters:

path - of a file

Returns:

true if file is a directory, false otherwise

dirname

public static java.lang.String dirname(java.lang.String path)

Returns the parent folder of the file.

Parameters:

path - of a file

Returns:

the parent folder of the file

executableʔ

public static boolean executableʔ(java.lang.String path)

Checks if a file is executable.

Parameters:

path - of a file

Returns:

true if the file is executable, false otherwise

existʔ

public static boolean existʔ(java.lang.String path)

Checks if a file existed.

Parameters:

path - of a file

Returns:

true if file existed, false otherwise

existsʔ

public static boolean existsʔ(java.lang.String path)

Equivalent to existʔ(String).

Parameters:

path - of a file

Returns:

true if file existed, false otherwise

expandPath

public static java.lang.String expandPath(java.lang.String path)

Returns the absolute path of the file.

Parameters:

path - of a file

Returns:

the absolute path of the file

expandPath

public static java.lang.String expandPath(java.lang.String file,
                          java.lang.String dir)

Returns the expanded path by given paths.

Parameters:

file - path of a file

dir - path of a directory

Returns:

the expanded path of the file

extname

public static java.lang.String extname(java.lang.String path)

Returns the extension name of the file.

Parameters:

path - of a file

Returns:

the extension name of the file

fileʔ

public static boolean fileʔ(java.lang.String path)

Checks if path is a file.

Parameters:

path - of a file

Returns:

true if path is a file, false otherwise

join

public static java.lang.String join(java.lang.String... files)

Returns a joined path by given files.

Parameters:

files - name of files

Returns:

joined path

readableʔ

public static boolean readableʔ(java.lang.String path)

Checks if a file is readable.

Parameters:

path - of a file

Returns:

true if the file is readable, false otherwise

size

public static long size(java.lang.String path)

Returns the size of a file.

Parameters:

path - of a file

Returns:

the size of a file in bytes

sizeʔ

public static java.lang.Long sizeʔ(java.lang.String path)

Returns null if filedoesn’t exist or has 0 in length, the size of the file otherwise.

Parameters:

path - of a file

Returns:

Long or null

writableʔ

public static boolean writableʔ(java.lang.String path)

Checks if a file is writable.

Parameters:

path - of a file

Returns:

true if the file is writable, false otherwise

zeroʔ

public static boolean zeroʔ(java.lang.String path)

Checks if the file gets 0 length.

Parameters:

path - of a file

Returns:

true if file existed and gets 0 in length, otherwise false

mtime

public java.util.Date mtime()

Returns the last modified Data of the file.

Returns:

the last modified Data of the file

path

public java.lang.String path()

Returns the path of the file.

Returns:

the path of the file.

size

public long size()

Returns the size of the file in bytes.

Returns:

the size of the file in bytes

toPath

public java.lang.String toPath()

Returns the path of the file.

Returns:

the path of the file.

toString

public java.lang.String toString()

Overrides:

toString in class RubyIO