RubyFile (JRuby Core 9.0.0.0.pre2 API)

java.lang.Object
- org.jruby.RubyBasicObject
- - org.jruby.RubyObject
  - - org.jruby.RubyIO
    - - org.jruby.RubyFile

All Implemented Interfaces:

Serializable, Cloneable, Comparable<IRubyObject>, InstanceVariables, InternalVariables, IRubyObject, EncodingCapable, CoreObjectType, IOEncodable

Direct Known Subclasses:

Tempfile
```
public class RubyFile
extends RubyIO
implements EncodingCapable
```
Ruby File class equivalent in java.

See Also:
Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class org.jruby.RubyObject
  RubyObject.Data
- Nested classes/interfaces inherited from class org.jruby.RubyBasicObject
  RubyBasicObject.Finalizer
- Nested classes/interfaces inherited from interface org.jruby.util.io.IOEncodable
  IOEncodable.ConvConfig

Field Summary

Fields
Modifier and Type Field and Description

static int LOCK_EX

static int LOCK_NB

static int LOCK_SH

static int LOCK_UN

protected String path
Deprecated.
- Fields inherited from class org.jruby.RubyIO
  CLOSED_STREAM_MSG, openFile, PARAGRAPH_DELIMETER, PARAGRAPH_SEPARATOR, popenSpecial
- Fields inherited from class org.jruby.RubyObject
  FIELD_ALLOCATED_CLASSES, FIELD_ALLOCATORS, IVAR_INSPECTING_OBJECT_ALLOCATOR, OBJECT_ALLOCATOR, OBJECT_VAR0_ALLOCATOR, OBJECT_VAR1_ALLOCATOR, OBJECT_VAR2_ALLOCATOR, OBJECT_VAR3_ALLOCATOR, OBJECT_VAR4_ALLOCATOR, OBJECT_VAR5_ALLOCATOR, OBJECT_VAR6_ALLOCATOR, OBJECT_VAR7_ALLOCATOR, OBJECT_VAR8_ALLOCATOR, OBJECT_VAR9_ALLOCATOR, REIFYING_OBJECT_ALLOCATOR
- Fields inherited from class org.jruby.RubyBasicObject
  ALL_F, BASICOBJECT_ALLOCATOR, COMPARE_BY_IDENTITY_F, ERR_INSECURE_SET_INST_VAR, FALSE_F, FL_USHIFT, flags, FROZEN_F, IS_OVERLAID_F, metaClass, NEVER, NIL_F, REFINED_MODULE_F, STAMP_OFFSET, TAINTED_F, UNDEF, UNTRUST_F, USER0_F, USER1_F, USER2_F, USER3_F, USER4_F, USER5_F, USER6_F, USER7_F, USER8_F, USER9_F, USERA_F, VAR_TABLE_OFFSET, varTable, varTableStamp
- Fields inherited from interface org.jruby.runtime.builtin.IRubyObject
  NULL_ARRAY

Fields
Modifier and Type	Field and Description
`static int`	`LOCK_EX`
`static int`	`LOCK_NB`
`static int`	`LOCK_SH`
`static int`	`LOCK_UN`
`protected String`	`path` Deprecated.

Constructor Summary

Constructors
Constructor and Description
`RubyFile(Ruby runtime, RubyClass type)`
`RubyFile(Ruby runtime, String path, InputStream in)`
`RubyFile(Ruby runtime, String path, Reader reader)`

Method Summary

Methods
Modifier and Type	Method and Description
`static IRubyObject`	`absolute_path(ThreadContext context, IRubyObject recv, IRubyObject[] args)` ---------------------------------------------------- File::absolute_path File.absolute_path(file_name [, dir_string] ) -> abs_file_name From Ruby 1.9.1 ------------------------------------------------------------------------ Converts a pathname to an absolute pathname.
`IRubyObject`	`atime(ThreadContext context)`
`static IRubyObject`	`atime(ThreadContext context, IRubyObject recv, IRubyObject filename)`
`static IRubyObject`	`basename(ThreadContext context, IRubyObject recv, IRubyObject[] args)`
`IRubyObject`	`birthtime(ThreadContext context)`
`static IRubyObject`	`birthtime(ThreadContext context, IRubyObject recv, IRubyObject filename)`
`static String`	`canonicalize(String path)`
`IRubyObject`	`chmod(ThreadContext context, IRubyObject arg)`
`static IRubyObject`	`chmod(ThreadContext context, IRubyObject recv, IRubyObject[] args)`
`IRubyObject`	`chown(ThreadContext context, IRubyObject arg1, IRubyObject arg2)`
`static IRubyObject`	`chown(ThreadContext context, IRubyObject recv, IRubyObject[] args)`
`static RubyClass`	`createFileClass(Ruby runtime)`
`IRubyObject`	`ctime(ThreadContext context)`
`static IRubyObject`	`ctime(ThreadContext context, IRubyObject recv, IRubyObject filename)`
`static IRubyObject`	`delete(ThreadContext context, IRubyObject recv, IRubyObject[] args)`
`static IRubyObject`	`dirname(ThreadContext context, IRubyObject recv, IRubyObject arg)`
`static String`	`dirname(ThreadContext context, String jfilename)`
`static IRubyObject`	`expand_path(ThreadContext context, IRubyObject recv, IRubyObject[] args)` Converts a pathname to an absolute pathname.
`static IRubyObject`	`expand_path19(ThreadContext context, IRubyObject recv, IRubyObject[] args)`
`static String`	`expandUserPath(ThreadContext context, String path)` This method checks a path, and if it starts with ~, then it expands the path to the absolute path of the user's home directory.
`static String`	`expandUserPath(ThreadContext context, String path, boolean raiseOnRelativePath)`
`static IRubyObject`	`extname(ThreadContext context, IRubyObject recv, IRubyObject arg)` Returns the extension name of the file.
`static JRubyFile`	`file(IRubyObject pathOrFile)` Deprecated.
`IRubyObject`	`fileOpenGeneric(ThreadContext context, IRubyObject filename, int oflags, int fmode, IOEncodable convConfig, int perm)`
`static FileResource`	`fileResource(IRubyObject pathOrFile)` Get the fully-qualified JRubyFile object for the path, taking into account the runtime's current directory.
`static FileResource`	`fileResource(ThreadContext context, IRubyObject pathOrFile)`
`IRubyObject`	`flock(ThreadContext context, IRubyObject operation)`
`static IRubyObject`	`fnmatch(ThreadContext context, IRubyObject recv, IRubyObject[] args)` Returns true if path matches against pattern The pattern is not a regular expression; instead it follows rules similar to shell filename globbing.
`static IRubyObject`	`ftype(ThreadContext context, IRubyObject recv, IRubyObject filename)`
`static RubyString`	`get_path(ThreadContext context, IRubyObject path)`
`static java.nio.file.attribute.FileTime`	`getBirthtimeWithNIO(String pathString)`
`static ZipEntry`	`getDirOrFileEntry(String jar, String path)`
`static ZipEntry`	`getDirOrFileEntry(ZipFile zf, String path)`
`org.jcodings.Encoding`	`getEncoding()`
`static ZipEntry`	`getFileEntry(ZipFile zf, String path)`
`String`	`getPath()`
`IRubyObject`	`initialize(ThreadContext context, IRubyObject[] args, Block block)`
`IRubyObject`	`initialize19(IRubyObject[] args, Block block)` Deprecated.
`IRubyObject`	`inspect()` rb_obj_inspect call-seq: obj.inspect => string Returns a string containing a human-readable representation of obj.
`static RubyString`	`join(ThreadContext context, IRubyObject recv, IRubyObject[] args)`
`static IRubyObject`	`lchmod(ThreadContext context, IRubyObject recv, IRubyObject[] args)`
`static IRubyObject`	`lchown(ThreadContext context, IRubyObject recv, IRubyObject[] args)`
`static IRubyObject`	`link(ThreadContext context, IRubyObject recv, IRubyObject from, IRubyObject to)`
`IRubyObject`	`lstat(ThreadContext context)`
`static IRubyObject`	`lstat(ThreadContext context, IRubyObject recv, IRubyObject filename)`
`IRubyObject`	`mtime(ThreadContext context)`
`static IRubyObject`	`mtime(ThreadContext context, IRubyObject recv, IRubyObject filename)`
`protected IRubyObject`	`openFile(ThreadContext context, IRubyObject[] args)`
`IRubyObject`	`path(ThreadContext context)`
`static IRubyObject`	`path(ThreadContext context, IRubyObject self, IRubyObject str)`
`protected IRubyObject`	`rbIoClose(Ruby runtime)`
`static IRubyObject`	`readlink(ThreadContext context, IRubyObject recv, IRubyObject path)`
`static IRubyObject`	`realdirpath(ThreadContext context, IRubyObject recv, IRubyObject[] args)`
`static IRubyObject`	`realpath(ThreadContext context, IRubyObject recv, IRubyObject[] args)`
`static IRubyObject`	`rename(ThreadContext context, IRubyObject recv, IRubyObject oldName, IRubyObject newName)`
`void`	`setEncoding(org.jcodings.Encoding encoding)`
`IRubyObject`	`size(ThreadContext context)`
`static RubyArray`	`split(ThreadContext context, IRubyObject recv, IRubyObject arg)`
`static String[]`	`splitURI(String path)`
`static boolean`	`startsWithDriveLetterOnWindows(String path)`
`static IRubyObject`	`stat(ThreadContext context, IRubyObject recv, IRubyObject filename)`
`static IRubyObject`	`symlink(ThreadContext context, IRubyObject recv, IRubyObject from, IRubyObject to)`
`String`	`toString()` The default toString method is just a wrapper that calls the Ruby "to_s" method.
`IRubyObject`	`truncate(ThreadContext context, IRubyObject len)`
`static IRubyObject`	`truncate(ThreadContext context, IRubyObject recv, IRubyObject arg1, IRubyObject arg2)`
`static IRubyObject`	`truncate19(ThreadContext context, IRubyObject recv, IRubyObject arg1, IRubyObject arg2)`
`static IRubyObject`	`umask(ThreadContext context, IRubyObject recv, IRubyObject[] args)`
`static IRubyObject`	`unlink(ThreadContext context, IRubyObject... args)`
`static IRubyObject`	`unlink(ThreadContext context, IRubyObject recv, IRubyObject[] args)`
`static IRubyObject`	`utime(ThreadContext context, IRubyObject recv, IRubyObject[] args)`

Methods inherited from class org.jruby.RubyIO
addBlockingThread, advise, autoclose_set, autoclose, binmode, binread, binwrite, bytes, chars, chars19, checkExecEnv, checkExecOptions, checkPopenOptions, checkSpawnOptions, close_on_exec_p, close_on_exec_set, close_read, close_write, close, closed_p, codepoints, convertToIO, copy_stream, createIOClass, ctl, doReadNonblock, doWriteNonblock, each_byte, each_byteInternal, each_char, each_char19, each_charInternal, each_codepoint, each_line, each, ensureYieldClose, ensureYieldClosePipes, eof_p, external_encoding, failIfDirectory, fcntl, fcntl, fileno, flush, flushRaw, for_fd, foreach, fsync, getBlocking, getBOM, getbyte, getByte, getc, getc19, getChannel, getEcflags, getEcopts, getEnc, getEnc2, getInputEncoding, getInStream, getIOModes, getIOModesIntFromString, getline, getline, getline, getline, getline, getline, getNativeClassIndex, getOpenFile, getOpenFileChecked, getOutStream, getReadEncoding, gets, gets, gets, getSync, GetWriteIO, initialize_copy, initialize, initialize, initialize, internal_encoding, interruptBlockingThreads, ioClose, ioctl, ioOpen, ioStaticWrite, isAutoclose, isClosed, lineno_set, lineno, lines, lines19, MakeOpenFile, newInstance, newIO, newIOOptions, newIOOptions, newIOOptions, newIOOptions, newIOOptions, newModeFlags, newModeFlags, newModeFlags, obliterateProcess, op_append, op_binmode, open, parseIOOptions, pid, pipe, pipe19, pipe19, pipe19, popen, popen3_19, popen3, popen4, popenSpecial, pos_set, pos, prepStdio, prepStdio, print, print, printf, putc, putc, puts, puts, puts, puts, puts, puts, puts0, puts1, puts2, puts3, read_nonblock, read, read, read, read, read, read19, readbyte, readchar, readchar, readline, readline, readline, readlines, readlines, readlines19, readlines19, readpartial, removeBlockingThread, reopen, reopenIO, restartSystemCall, rewind, seek, seek, seek, select_static, select, set_encoding, set_encoding, set_encoding, setAscii8bitBinmode, setAutoclose, setBlocking, setBOM, setEcflags, setEcopts, setEnc, setEnc2, setEncoding, setSync, stat, sync_set, sync, sysopen, sysopen, sysopen19, sysread, sysseek, syswrite, to_io, tryConvert, tty_p, ungetbyte, ungetc, updateIOOptionsFromOptions, write_nonblock, write, write, write, write, write, write, writeStatic

Methods inherited from class org.jruby.RubyObject
attachToObjectSpace, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, convertToType, createObjectClass, eqlInternal, equalInternal, equals, hashCode, initialize, initialize, inspect, op_eqq, puts, specificEval

Methods inherited from class org.jruby.RubyBasicObject
addFinalizer, anyToString, asJavaString, asString, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callSuper, checkArrayType, checkCallMethod, checkFrozen, checkStringType, checkStringType19, compareTo, convertToArray, convertToFloat, convertToHash, convertToInteger, convertToInteger, convertToInteger, convertToString, copyInstanceVariablesInto, copySpecialInstanceVariables, createBasicObjectClass, dataGetStruct, dataGetStructChecked, dataWrapStruct, display, dup, ensureInstanceVariablesSettable, eql_p, eql, equal_p, equal_p19, evalUnder, extend, fastGetInstanceVariable, fastGetInternalVariable, fastHasInstanceVariable, fastHasInternalVariable, fastSetInstanceVariable, fastSetInternalVariable, freeze, frozen_p, getFFIHandle, getFlag, getInstanceEvalClass, getInstanceVariable, getInstanceVariableList, getInstanceVariableNameList, getInstanceVariables, getInternalVariable, getInternalVariables, getJavaClass, getMetaClass, getNativeHandle, getNativeTypeIndex, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getType, getVariable, getVariableCount, getVariableList, getVariableNameList, hash, hashyInspect, hasInstanceVariable, hasInternalVariable, hasVariables, id, infectBy, initialize19, inspectHashCode, instance_eval, instance_eval, instance_eval, instance_eval, instance_eval19, instance_eval19, instance_eval19, instance_eval19, instance_exec, instance_exec19, instance_of_p, instance_variable_defined_p, instance_variable_get, instance_variable_set, instance_variables, instance_variables19, isBuiltin, isClass, isFalse, isFrozen, isImmediate, isModule, isNil, isSpecialConst, isTaint, isTrue, isUntrusted, kind_of_p, makeMetaClass, method_missing19, method, method19, methods, methods, methods19, nil_p, OBJ_INIT_COPY, objInitCopy, op_cmp, op_equal_19, op_equal, op_match, op_match19, op_not_equal, op_not_match, op_not, private_methods, private_methods19, protected_methods, protected_methods19, public_methods, public_methods19, rbClone, rbInspect, remove_instance_variable, removeFinalizers, removeInstanceVariable, removeInternalVariable, respond_to_p, respond_to_p, respond_to_p19, respond_to_p19, respondsTo, respondsToMissing, respondsToMissing, send, send, send, send, send, send19, send19, send19, send19, setFFIHandle, setFlag, setFrozen, setInstanceVariable, setInternalVariable, setMetaClass, setNativeHandle, setTaint, setUntrusted, setVariable, singleton_method_added19, singleton_method_removed19, singleton_method_undefined19, singleton_methods, specificEval, specificEval, specificEval, specificEval, syncVariables, syncVariables, taint, taint, tainted_p, testFrozen, testFrozen, to_a, to_s, toJava, trust, type_deprecated, type, untaint, untrust, untrusted_p, validateInstanceVariable, variableTableContains, variableTableFastContains, variableTableFastFetch, variableTableFastStore, variableTableFetch, variableTableRemove, variableTableStore, variableTableSync, yieldUnder, yieldUnder

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail
- LOCK_SH
```
public static final int LOCK_SH
```
  See Also:
  Constant Field Values
- LOCK_EX
```
public static final int LOCK_EX
```
  See Also:
  Constant Field Values
- LOCK_NB
```
public static final int LOCK_NB
```
  See Also:
  Constant Field Values
- LOCK_UN
```
public static final int LOCK_UN
```
  See Also:
  Constant Field Values
- path
```
@Deprecated
protected String path
```
  Deprecated.

Constructor Detail

RubyFile

public RubyFile(Ruby runtime,
        RubyClass type)

RubyFile

public RubyFile(Ruby runtime,
        String path,
        Reader reader)

RubyFile

public RubyFile(Ruby runtime,
        String path,
        InputStream in)

Method Detail

createFileClass

public static RubyClass createFileClass(Ruby runtime)

rbIoClose

protected IRubyObject rbIoClose(Ruby runtime)

Overrides:: rbIoClose in class RubyIO

flock

public IRubyObject flock(ThreadContext context,
                IRubyObject operation)

initialize

public IRubyObject initialize(ThreadContext context,
                     IRubyObject[] args,
                     Block block)

chmod

public IRubyObject chmod(ThreadContext context,
                IRubyObject arg)

chown

public IRubyObject chown(ThreadContext context,
                IRubyObject arg1,
                IRubyObject arg2)

atime

public IRubyObject atime(ThreadContext context)

ctime

public IRubyObject ctime(ThreadContext context)

birthtime

public IRubyObject birthtime(ThreadContext context)

getBirthtimeWithNIO

public static final java.nio.file.attribute.FileTime getBirthtimeWithNIO(String pathString)

lstat

public IRubyObject lstat(ThreadContext context)

mtime

public IRubyObject mtime(ThreadContext context)

path

public static IRubyObject path(ThreadContext context,
               IRubyObject self,
               IRubyObject str)

path

public IRubyObject path(ThreadContext context)

truncate

public IRubyObject truncate(ThreadContext context,
                   IRubyObject len)

inspect
```
public IRubyObject inspect()
```
Description copied from class: RubyBasicObject

rb_obj_inspect call-seq: obj.inspect => string Returns a string containing a human-readable representation of obj. If not overridden, uses the to_s method to generate the string. [ 1, 2, 3..4, 'five' ].inspect #=> "[1, 2, 3..4, \"five\"]" Time.new.inspect #=> "Wed Apr 09 08:54:39 CDT 2003"

Specified by:

inspect in interface IRubyObject

Overrides:

inspect in class RubyIO

Returns:
String

basename

public static IRubyObject basename(ThreadContext context,
                   IRubyObject recv,
                   IRubyObject[] args)

chmod

public static IRubyObject chmod(ThreadContext context,
                IRubyObject recv,
                IRubyObject[] args)

chown

public static IRubyObject chown(ThreadContext context,
                IRubyObject recv,
                IRubyObject[] args)

dirname

public static IRubyObject dirname(ThreadContext context,
                  IRubyObject recv,
                  IRubyObject arg)

dirname

public static String dirname(ThreadContext context,
             String jfilename)

extname
```
public static IRubyObject extname(ThreadContext context,
                  IRubyObject recv,
                  IRubyObject arg)
```
Returns the extension name of the file. An empty string is returned if the filename (not the entire path) starts or ends with a dot.

Parameters:
recv -
arg - Path to get extension name of

Returns:
Extension, including the dot, or an empty string

expand_path
```
public static IRubyObject expand_path(ThreadContext context,
                      IRubyObject recv,
                      IRubyObject[] args)
```
Converts a pathname to an absolute pathname. Relative paths are referenced from the current working directory of the process unless a second argument is given, in which case it will be used as the starting point. If the second argument is also relative, it will first be converted to an absolute pathname.

Parameters:
recv -
args -

Returns:
Resulting absolute path as a String

expand_path19

public static IRubyObject expand_path19(ThreadContext context,
                        IRubyObject recv,
                        IRubyObject[] args)

absolute_path
```
public static IRubyObject absolute_path(ThreadContext context,
                        IRubyObject recv,
                        IRubyObject[] args)
```
---------------------------------------------------- File::absolute_path File.absolute_path(file_name [, dir_string] ) -> abs_file_name From Ruby 1.9.1 ------------------------------------------------------------------------ Converts a pathname to an absolute pathname. Relative paths are referenced from the current working directory of the process unless _dir_string_ is given, in which case it will be used as the starting point. If the given pathname starts with a ``+~+'' it is NOT expanded, it is treated as a normal directory name. File.absolute_path("~oracle/bin") #=> "/~oracle/bin"

Parameters:
context -
recv -
args -

Returns:

realdirpath

public static IRubyObject realdirpath(ThreadContext context,
                      IRubyObject recv,
                      IRubyObject[] args)

realpath

public static IRubyObject realpath(ThreadContext context,
                   IRubyObject recv,
                   IRubyObject[] args)

fnmatch
```
public static IRubyObject fnmatch(ThreadContext context,
                  IRubyObject recv,
                  IRubyObject[] args)
```
Returns true if path matches against pattern The pattern is not a regular expression; instead it follows rules similar to shell filename globbing. It may contain the following metacharacters: *: Glob - match any sequence chars (re: .*). If like begins with '.' then it doesn't. ?: Matches a single char (re: .). [set]: Matches a single char in a set (re: [...]).

ftype

public static IRubyObject ftype(ThreadContext context,
                IRubyObject recv,
                IRubyObject filename)

join

public static RubyString join(ThreadContext context,
              IRubyObject recv,
              IRubyObject[] args)

lstat

public static IRubyObject lstat(ThreadContext context,
                IRubyObject recv,
                IRubyObject filename)

stat

public static IRubyObject stat(ThreadContext context,
               IRubyObject recv,
               IRubyObject filename)

atime

public static IRubyObject atime(ThreadContext context,
                IRubyObject recv,
                IRubyObject filename)

ctime

public static IRubyObject ctime(ThreadContext context,
                IRubyObject recv,
                IRubyObject filename)

birthtime

public static IRubyObject birthtime(ThreadContext context,
                    IRubyObject recv,
                    IRubyObject filename)

lchmod

public static IRubyObject lchmod(ThreadContext context,
                 IRubyObject recv,
                 IRubyObject[] args)

lchown

public static IRubyObject lchown(ThreadContext context,
                 IRubyObject recv,
                 IRubyObject[] args)

link

public static IRubyObject link(ThreadContext context,
               IRubyObject recv,
               IRubyObject from,
               IRubyObject to)

mtime

public static IRubyObject mtime(ThreadContext context,
                IRubyObject recv,
                IRubyObject filename)

rename

public static IRubyObject rename(ThreadContext context,
                 IRubyObject recv,
                 IRubyObject oldName,
                 IRubyObject newName)

split

public static RubyArray split(ThreadContext context,
              IRubyObject recv,
              IRubyObject arg)

symlink

public static IRubyObject symlink(ThreadContext context,
                  IRubyObject recv,
                  IRubyObject from,
                  IRubyObject to)

readlink

public static IRubyObject readlink(ThreadContext context,
                   IRubyObject recv,
                   IRubyObject path)

truncate

public static IRubyObject truncate(ThreadContext context,
                   IRubyObject recv,
                   IRubyObject arg1,
                   IRubyObject arg2)

truncate19

public static IRubyObject truncate19(ThreadContext context,
                     IRubyObject recv,
                     IRubyObject arg1,
                     IRubyObject arg2)

umask

public static IRubyObject umask(ThreadContext context,
                IRubyObject recv,
                IRubyObject[] args)

utime

public static IRubyObject utime(ThreadContext context,
                IRubyObject recv,
                IRubyObject[] args)

delete

public static IRubyObject delete(ThreadContext context,
                 IRubyObject recv,
                 IRubyObject[] args)

unlink

public static IRubyObject unlink(ThreadContext context,
                 IRubyObject recv,
                 IRubyObject[] args)

unlink

public static IRubyObject unlink(ThreadContext context,
                 IRubyObject... args)

size

public IRubyObject size(ThreadContext context)

getPath
```
public String getPath()
```

getEncoding
```
public org.jcodings.Encoding getEncoding()
```
Specified by:

getEncoding in interface EncodingCapable

setEncoding
```
public void setEncoding(org.jcodings.Encoding encoding)
```
Specified by:

setEncoding in interface EncodingCapable

openFile

protected IRubyObject openFile(ThreadContext context,
                   IRubyObject[] args)

fileOpenGeneric

public IRubyObject fileOpenGeneric(ThreadContext context,
                          IRubyObject filename,
                          int oflags,
                          int fmode,
                          IOEncodable convConfig,
                          int perm)

get_path

public static RubyString get_path(ThreadContext context,
                  IRubyObject path)

fileResource

public static FileResource fileResource(ThreadContext context,
                        IRubyObject pathOrFile)

fileResource
```
public static FileResource fileResource(IRubyObject pathOrFile)
```
Get the fully-qualified JRubyFile object for the path, taking into account the runtime's current directory.

file

@Deprecated
public static JRubyFile file(IRubyObject pathOrFile)

Deprecated.

toString
```
public String toString()
```
Description copied from class: RubyObject

The default toString method is just a wrapper that calls the Ruby "to_s" method.

Overrides:

toString in class RubyIO

getFileEntry

public static ZipEntry getFileEntry(ZipFile zf,
                    String path)
                             throws IOException

Throws:: IOException

getDirOrFileEntry

public static ZipEntry getDirOrFileEntry(String jar,
                         String path)
                                  throws IOException

Throws:: IOException

getDirOrFileEntry

public static ZipEntry getDirOrFileEntry(ZipFile zf,
                         String path)
                                  throws IOException

Throws:: IOException

startsWithDriveLetterOnWindows

public static boolean startsWithDriveLetterOnWindows(String path)

splitURI

public static String[] splitURI(String path)

expandUserPath
```
public static String expandUserPath(ThreadContext context,
                    String path)
```
This method checks a path, and if it starts with ~, then it expands the path to the absolute path of the user's home directory. If the string does not begin with ~, then the string is simply returned. unaltered.

Parameters:
context -
path - Path to check

Returns:
Expanded path

expandUserPath

public static String expandUserPath(ThreadContext context,
                    String path,
                    boolean raiseOnRelativePath)

canonicalize

public static String canonicalize(String path)

initialize19

@Deprecated
public IRubyObject initialize19(IRubyObject[] args,
                                  Block block)

Deprecated.

Class RubyFile

Nested Class Summary

Nested classes/interfaces inherited from class org.jruby.RubyObject

Nested classes/interfaces inherited from class org.jruby.RubyBasicObject

Nested classes/interfaces inherited from interface org.jruby.util.io.IOEncodable

Field Summary

Fields inherited from class org.jruby.RubyIO

Fields inherited from class org.jruby.RubyObject

Fields inherited from class org.jruby.RubyBasicObject

Fields inherited from interface org.jruby.runtime.builtin.IRubyObject

Constructor Summary

Method Summary

Methods inherited from class org.jruby.RubyIO

Methods inherited from class org.jruby.RubyObject

Methods inherited from class org.jruby.RubyBasicObject

Methods inherited from class java.lang.Object

Field Detail

LOCK_SH

LOCK_EX

LOCK_NB

LOCK_UN

path

Constructor Detail

RubyFile

RubyFile

RubyFile

Method Detail

createFileClass

rbIoClose

flock

initialize

chmod

chown

atime

ctime

birthtime

getBirthtimeWithNIO

lstat

mtime

path

path

truncate

inspect

basename

chmod

chown

dirname

dirname

extname

expand_path

expand_path19

absolute_path

realdirpath

realpath

fnmatch

ftype

join

lstat

stat

atime

ctime

birthtime

lchmod

lchown

link

mtime

rename

split

symlink

readlink

truncate

truncate19

umask

utime

delete

unlink

unlink

size

getPath

getEncoding