net.sf.rubycollect4j

Class RubyIO

java.lang.Object

net.sf.rubycollect4j.RubyIO

Direct Known Subclasses:

RubyFile

public class RubyIO
extends java.lang.Object

RubyIO implements part of the methods refer to the IO class of Ruby.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RubyIO.Mode This Mode enum contains all open modes of RubyIO. r : Read. r+ : Read and Write. w : Write. w+ : Write and Read. a : Append. a+ : Append and Read.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.io.File	file
protected RubyIO.Mode	mode
protected java.io.RandomAccessFile	raFile

Constructor Summary

Constructors

Constructor and Description
RubyIO(java.io.File file, RubyIO.Mode mode) Creates a RubyIO by given File and Mode.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes this IO.
RubyEnumerator<java.lang.String>	eachLine() Returns a RubyEnumerator of lines in the file.
static RubyEnumerator<java.lang.String>	foreach(java.lang.String path) Returns a RubyEnumerator of lines in given file.
static void	foreach(java.lang.String path, Block<java.lang.String> block) Iterates a file line by line.
static RubyIO	open(java.lang.String path) Creates a RubyIO by given file.
static RubyIO	open(java.lang.String path, java.lang.String mode) Creates a RubyIO by given path and mode.
void	puts(java.lang.String words) Writes a line in the file.
java.lang.String	read() Reads the content of a file.
void	seek(long pos) Moves the cursor to certain position.
java.lang.String	toString()
int	write(java.lang.String words) Writes to the file.

Methods inherited from class java.lang.Object

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

Field Detail

file

protected final java.io.File file

raFile

protected final java.io.RandomAccessFile raFile

mode

protected final RubyIO.Mode mode

Constructor Detail

RubyIO

public RubyIO(java.io.File file,
      RubyIO.Mode mode)
       throws java.io.IOException

Creates a RubyIO by given File and Mode.

Parameters:

file - a File

mode - a Mode

Throws:

java.lang.NullPointerException - if file is null

java.io.IOException - if file can't not open

See Also:

RubyIO.Mode

Method Detail

open

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

Creates a RubyIO by given path and mode.

Parameters:

path - of a File

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

Returns:

RubyIO

See Also:

RubyIO.Mode

open

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

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

Parameters:

path - of a file

Returns:

RubyIO

foreach

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

Returns a RubyEnumerator of lines in given file.

Parameters:

path - of a File

Returns:

RubyEnumerator

foreach

public static void foreach(java.lang.String path,
           Block<java.lang.String> block)

Iterates a file line by line.

Parameters:

path - of a File

block - to process each line

close

public void close()

Closes this IO.

eachLine

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

Returns a RubyEnumerator of lines in the file.

Returns:

RubyEnumerator

Throws:

java.lang.IllegalStateException - if file is not readable

puts

public void puts(java.lang.String words)

Writes a line in the file.

Parameters:

words - to write a line

Throws:

java.lang.IllegalStateException - if file is not writable

read

public java.lang.String read()

Reads the content of a file.

Returns:

String

Throws:

java.lang.IllegalStateException - if file is not readable

seek

public void seek(long pos)

Moves the cursor to certain position.

Parameters:

pos - position of the file

write

public int write(java.lang.String words)

Writes to the file.

Parameters:

words - to write

Returns:

the number of written bytes.

Throws:

java.lang.IllegalStateException - if file is not writable

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object