net.sf.rubycollect4j

Class RubyDir

java.lang.Object

net.sf.rubycollect4j.RubyEnumerable<java.lang.String>

net.sf.rubycollect4j.RubyDir

All Implemented Interfaces:

java.lang.Iterable<java.lang.String>, Ruby.Enumerable<java.lang.String>, RubyContract.Enumerable<java.lang.String,Ruby.Enumerator<?>,RubyArray<?>>

public final class RubyDir
extends RubyEnumerable<java.lang.String>

RubyDir implements parts of the methods refer to the Dir class of Ruby.

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	delete(java.lang.String path) Deletes a directory.
RubyEnumerator<java.lang.String>	each() Creates a RubyEnumerator of entries of this RubyDir.
RubyDir	each(Block<? super java.lang.String> block) Yields each entry to the given block.
static RubyArray<java.lang.String>	entries(java.lang.String path) Puts entries of a folder into a RubyArray.
static boolean	existsʔ(java.lang.String path) Checks if the file is a directory.
static boolean	existʔ(java.lang.String path) Checks if the file is a directory.
static RubyEnumerator<java.lang.String>	foreach(java.lang.String path) Creates a RubyEnumerator of entries of the given path.
protected java.lang.Iterable<java.lang.String>	getIterable() Returns an Iterable of elements.
static RubyArray<java.lang.String>	glob(java.lang.String pattern) Retrieves all paths of files of given url pattern.
static java.lang.String	home() Finds the home directory of current user.
static boolean	mkdir(java.lang.String path) Creates a directory.
static RubyDir	open(java.lang.String path) Creates a RubyDir by given path.
java.lang.String	path() Returns the path of this RubyDir.
int	pos() Returns the current position of entries.
int	pos(int position) Sets the current position of entries.
static java.lang.String	pwd() Returns the present working directory.
java.lang.String	read() Returns the next of entries.
RubyDir	rewind() Sets 0 to the position of entries.
RubyDir	seek(int position) Returns a RubyDir that entries is set to the given position.
int	tell() Returns the current position of entries.
java.lang.String	toString()

Methods inherited from class net.sf.rubycollect4j.RubyEnumerable

allʔ, allʔ, anyʔ, anyʔ, chunk, chunk, collect, collect, collect, collectConcat, collectConcat, count, count, cycle, cycle, cycle, cycle, detect, detect, drop, dropWhile, dropWhile, eachCons, eachCons, eachEntry, eachEntry, eachSlice, eachSlice, eachWithIndex, eachWithIndex, eachWithObject, eachWithObject, entries, find, find, findAll, findAll, findIndex, findIndex, findIndex, first, first, flatMap, flatMap, grep, grep, grep, groupBy, groupBy, groupBy, includeʔ, inject, inject, inject, inject, iterator, lazy, map, map, map, max, max, maxBy, maxBy, maxBy, maxBy, memberʔ, min, min, minBy, minBy, minBy, minBy, minmax, minmax, minmaxBy, minmaxBy, minmaxBy, minmaxBy, noneʔ, noneʔ, oneʔ, oneʔ, partition, partition, reduce, reduce, reduce, reduce, reject, reject, reverseEach, reverseEach, select, select, sliceBefore, sliceBefore, sort, sortBy, sortBy, sortBy, sortBy, sortBy, take, takeWhile, takeWhile, toA, zip, zip, zip

Methods inherited from class java.lang.Object

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

Method Detail

getIterable

protected java.lang.Iterable<java.lang.String> getIterable()

Description copied from class: RubyEnumerable

Returns an Iterable of elements.

Specified by:

getIterable in class RubyEnumerable<java.lang.String>

Returns:

Iterable

open

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

Creates a RubyDir by given path.

Parameters:

path - of a file

Returns:

RubyDir

Throws:

java.lang.IllegalArgumentException - if no such file or directory

delete

public static boolean delete(java.lang.String path)

Deletes a directory.

Parameters:

path - of a file

Returns:

true if the directory is deleted,false otherwise

entries

public static RubyArray<java.lang.String> entries(java.lang.String path)

Puts entries of a folder into a RubyArray.

Parameters:

path - of a file

Returns:

RubyArray

existsʔ

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

Checks if the file is a directory.

Parameters:

path - of a file

Returns:

true if the file is a directory, false otherwise

existʔ

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

Checks if the file is a directory.

Parameters:

path - of a file

Returns:

true if the file is a directory, false otherwise

foreach

public static RubyEnumerator<java.lang.String> foreach(java.lang.String path)

Creates a RubyEnumerator of entries of the given path.

Parameters:

path - of a file

Returns:

RubyEnumerator

glob

public static RubyArray<java.lang.String> glob(java.lang.String pattern)

Retrieves all paths of files of given url pattern. The glob pattern is NOT fully implemented yet. Be careful!
* Matches any file.
** Matches directories recursively.
? Matches any one character. Equivalent to /.{1}/ in regexp.
[set] Matches any one character in set.

Parameters:

pattern - of target files

Returns:

RubyArray

home

public static java.lang.String home()

Finds the home directory of current user.

Returns:

the home directory of current user

mkdir

public static boolean mkdir(java.lang.String path)

Creates a directory.

Parameters:

path - of a file

Returns:

true if the directory is created, false otherwise

pwd

public static java.lang.String pwd()

Returns the present working directory.

Returns:

the present working directory

each

public RubyEnumerator<java.lang.String> each()

Creates a RubyEnumerator of entries of this RubyDir.

Specified by:

each in interface Ruby.Enumerable<java.lang.String>

Specified by:

each in interface RubyContract.Enumerable<java.lang.String,Ruby.Enumerator<?>,RubyArray<?>>

Overrides:

each in class RubyEnumerable<java.lang.String>

Returns:

RubyEnumerator

each

public RubyDir each(Block<? super java.lang.String> block)

Yields each entry to the given block.

Specified by:

each in interface Ruby.Enumerable<java.lang.String>

Specified by:

each in interface RubyContract.Enumerable<java.lang.String,Ruby.Enumerator<?>,RubyArray<?>>

Overrides:

each in class RubyEnumerable<java.lang.String>

Parameters:

block - to yield entries

Returns:

this RubyDir

path

public java.lang.String path()

Returns the path of this RubyDir.

Returns:

the path of this RubyDir

pos

public int pos()

Returns the current position of entries.

Returns:

the current position of entries

pos

public int pos(int position)

Sets the current position of entries.

Parameters:

position - the current index of entries to be set

Returns:

the current position of entries

read

public java.lang.String read()

Returns the next of entries.

Returns:

entry of file

rewind

public RubyDir rewind()

Sets 0 to the position of entries.

Returns:

this RubyDir

seek

public RubyDir seek(int position)

Returns a RubyDir that entries is set to the given position.

Parameters:

position - to be searched

Returns:

RubyDir that entries is set to the given position

tell

public int tell()

Returns the current position of entries.

Returns:

the current position of entries

toString

public java.lang.String toString()

Overrides:

toString in class RubyEnumerable<java.lang.String>