Package org.jruby

Class RubyFile

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.RubyIO

org.jruby.RubyFile

All Implemented Interfaces:

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

public class RubyFile
extends RubyIO
implements EncodingCapable

The Ruby File class.

See Also:

• Serialized Form

Nested Class Summary

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

RubyIO.IOEvent, RubyIO.RubyIOTimeoutError, RubyIO.Sysopen, RubyIO.TimeoutError

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	Description
static final int	LOCK_EX
static final int	LOCK_NB
static final int	LOCK_SH
static final int	LOCK_UN
protected String	path	Deprecated.

Fields inherited from class org.jruby.RubyIO

CLOSED_STREAM_MSG, FD_CLOEXEC, openFile, PARAGRAPH_SEPARATOR, popenSpecial

Fields inherited from class org.jruby.RubyObject

IVAR_INSPECTING_OBJECT_ALLOCATOR, OBJECT_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, 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

Constructor Summary

Constructors

Constructor	Description
RubyFile(Ruby runtime, String path, InputStream in)
RubyFile(Ruby runtime, String path, FileChannel channel)
RubyFile(Ruby runtime, RubyClass type)

Method Summary

Modifier and Type	Method	Description
static IRubyObject	absolute_path(ThreadContext context, IRubyObject recv, IRubyObject path)	Converts a pathname to an absolute pathname.
static IRubyObject	absolute_path(ThreadContext context, IRubyObject recv, IRubyObject[] args)	Deprecated.
static IRubyObject	absolute_path(ThreadContext context, IRubyObject recv, IRubyObject path, IRubyObject dir)	Converts a pathname to an absolute pathname.
static IRubyObject	absolute_path_p(ThreadContext context, IRubyObject recv, IRubyObject arg)
IRubyObject	atime(ThreadContext context)
static IRubyObject	atime(ThreadContext context, IRubyObject recv, IRubyObject filename)
static RubyString	basename(ThreadContext context, IRubyObject recv, IRubyObject path)
static IRubyObject	basename(ThreadContext context, IRubyObject recv, IRubyObject[] args)	Deprecated.
static RubyString	basename(ThreadContext context, IRubyObject recv, IRubyObject path, IRubyObject ext)
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(ThreadContext context, RubyClass IO)
IRubyObject	ctime(ThreadContext context)
static IRubyObject	ctime(ThreadContext context, IRubyObject recv, IRubyObject filename)
static IRubyObject	delete(ThreadContext context, IRubyObject recv, IRubyObject[] args)
static String	dirname(ThreadContext context, String filename)
static String	dirname(ThreadContext context, String filename, int level)
static IRubyObject	dirname(ThreadContext context, IRubyObject recv, IRubyObject path)
static IRubyObject	dirname(ThreadContext context, IRubyObject recv, IRubyObject[] args)	Deprecated.
static IRubyObject	dirname(ThreadContext context, IRubyObject recv, IRubyObject path, IRubyObject arg1)
static IRubyObject	expand_path(ThreadContext context, IRubyObject recv, IRubyObject path)	Converts a pathname to an absolute pathname.
static IRubyObject	expand_path(ThreadContext context, IRubyObject recv, IRubyObject... args)	Deprecated.
static IRubyObject	expand_path(ThreadContext context, IRubyObject recv, IRubyObject path, IRubyObject wd)	Converts a pathname to an absolute pathname.
static String	expandPath(ThreadContext context, String relativePath, org.jcodings.Encoding[] enc, String cwd, boolean expandUser, boolean canonicalize)
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)
protected static RubyString	filePathConvert(ThreadContext context, RubyString path)
static FileResource	fileResource(IRubyObject pathOrFile)	Deprecated.
static FileResource	fileResource(ThreadContext context, IRubyObject pathOrFile)	Get the fully-qualified JRubyFile object for the path, taking into account the runtime's current directory.
IRubyObject	flock(ThreadContext context, IRubyObject operation)
static IRubyObject	fnmatch(ThreadContext context, IRubyObject recv, IRubyObject[] args)	Deprecated.
static IRubyObject	fnmatch(ThreadContext context, IRubyObject recv, IRubyObject _pattern, IRubyObject _path)	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	fnmatch(ThreadContext context, IRubyObject recv, IRubyObject _pattern, IRubyObject _path, IRubyObject _flags)
static IRubyObject	ftype(ThreadContext context, IRubyObject recv, IRubyObject filename)
static RubyString	get_path(ThreadContext context, IRubyObject path)
static String	getAdjustedPath(ThreadContext context, IRubyObject fileOrPath)
static String	getAdjustedPath(ThreadContext context, IRubyObject fileOrPath, String currentDirectory)
static final FileTime	getBirthtimeWithNIO(String pathString)
static ZipEntry	getDirOrFileEntry(String jar, String path)	Deprecated.
static ZipEntry	getDirOrFileEntry(ZipFile jar, String path)	Deprecated.
org.jcodings.Encoding	getEncoding()
IRubyObject	initialize(ThreadContext context, IRubyObject[] args, Block block)
RubyString	inspect(ThreadContext context)	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)
static IRubyObject	lutime(ThreadContext context, IRubyObject recv, IRubyObject[] args)
static IRubyObject	mkfifo(ThreadContext context, RubyString path, int mode)
static IRubyObject	mkfifo(ThreadContext context, IRubyObject recv, IRubyObject path)
static IRubyObject	mkfifo(ThreadContext context, IRubyObject recv, IRubyObject path, IRubyObject mode)
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(ThreadContext context)
static IRubyObject	readlink(ThreadContext context, IRubyObject recv, IRubyObject path)
static IRubyObject	realdirpath(ThreadContext context, IRubyObject recv, IRubyObject path)
static IRubyObject	realdirpath(ThreadContext context, IRubyObject recv, IRubyObject[] args)	Deprecated.
static IRubyObject	realdirpath(ThreadContext context, IRubyObject recv, IRubyObject path, IRubyObject dir)
static IRubyObject	realpath(ThreadContext context, IRubyObject recv, IRubyObject path)
static IRubyObject	realpath(ThreadContext context, IRubyObject recv, IRubyObject[] args)	Deprecated.
static IRubyObject	realpath(ThreadContext context, IRubyObject recv, IRubyObject path, IRubyObject cwd)
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)
<T> T	toJava(Class<T> target)	Convert the object to the specified Java class, if possible.
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 path, IRubyObject length)
static IRubyObject	truncate19(ThreadContext context, IRubyObject recv, IRubyObject path, IRubyObject length)	Deprecated.
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, autoclose_set, binmode, binmode, binread, binwrite, bytes, chars, checkExecEnv, checkExecOptions, checkLength, checkPopenOptions, checkSpawnOptions, cloexecOpen, close, close, close_on_exec_p, close_on_exec_set, close_read, close_write, closed_p, codepoints, convertToIO, copy_stream, copy_stream, copy_stream, createIOClass, doRead, doReadNonblock, doReadNonblock, doReadNonblock, doReadNonblock, doWriteNonblock, each, each, each, each, each, each_byte, each_byteInternal, each_char, each_charInternal, each_codepoint, each_line, each_line, each_line, each_line, each_line, ensureYieldClose, ensureYieldClosePipes, eof_p, external_encoding, failIfDirectory, fcntl, fcntl, fileno, flush, flush, flushRaw, for_fd, foreach, fsync, getBlocking, getBOM, getbyte, getByte, getc, getc, getChannel, getEcflags, getEcopts, getEnc, getEnc2, getInputEncoding, getInStream, getIOModes, getIOModesIntFromString, getline, getline, getline, getline, getline, getline, getNativeClassIndex, getOpenFile, getOpenFileChecked, getOpenFileInitialized, getOutStream, getPath, getReadEncoding, gets, gets, gets, gets, getSync, GetWriteIO, initialize, initialize, initialize, initialize_copy, internal_encoding, ioClose, ioctl, ioOpen, ioOpen, ioStaticWrite, isAutoclose, isClosed, lineno, lineno_set, lines, MakeOpenFile, newInstance, newIO, newIOOptions, newIOOptions, newIOOptions, newIOOptions, newIOOptions, newModeFlags, newModeFlags, newModeFlags, obliterateProcess, op_append, op_binmode, open, parseIOOptions, pid, pipe, pipe, pipe, pipe, pipe, pipe, popen, popen3, popen4, popenSpecial, pos, pos_set, pread, pread, prepStdio, prepStdio, print, print, print, print, print, print, print0, print1, print2, print3, printf, printf, putc, putc, puts, puts, puts, puts, puts, puts, puts0, puts1, puts2, puts3, pwrite, read, read, read, read, read, read, read, read, read_nonblock, read_nonblock, read_nonblock, read_nonblock, readbyte, readchar, readchar, readline, readline, readline, readline, readline, readlines, readlines, readlines, readlines, readlines, readlines, readpartial, readpartial, readpartial, removeBlockingThread, reopen, reopenIO, rewind, seek, seek, seek, select, select_static, set_encoding, set_encoding, set_encoding, set_encoding_by_bom, setAscii8bitBinmode, setAutoclose, setBlocking, setBOM, setEcflags, setEcopts, setEnc, setEnc2, setEncoding, setPath, setSync, stat, sync, sync_set, sync_set, sysopen, sysopen, sysopen, sysread, sysread, sysread, sysseek, syswrite, to_io, tryConvert, tty_p, ungetbyte, ungetc, updateIOOptionsFromOptions, wait, wait, wait_readable, wait_readable, wait_writable, wait_writable, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write_nonblock, write_nonblock, write_nonblock, write2, write3, writeStatic, writev, writev, writev, writev, writev

Methods inherited from class org.jruby.RubyObject

attachToObjectSpace, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, convertToType, dig, dig1, dig2, eqlInternal, equalInternal, equals, finishObjectClass, hashCode, inspect, op_eqq, puts, specificEval, toRubyString

Methods inherited from class org.jruby.RubyBasicObject

addFinalizer, addFinalizer, anyToString, asJavaString, asString, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callSuper, checkArrayType, checkCallMethod, checkCallMethod, checkFrozen, checkStringType, cloneSetup, compareTo, convertToArray, convertToFloat, convertToHash, convertToInteger, convertToInteger, convertToInteger, convertToString, copyInstanceVariablesInto, copySpecialInstanceVariables, dataGetStruct, dataGetStructChecked, dataWrapStruct, decode, display, dup, dupFinalizer, dupSetup, ensureInstanceVariablesSettable, eql, eql_p, eql_p, equal_p, evalUnder, extend, fastGetInstanceVariable, fastGetInternalVariable, fastHasInstanceVariable, fastHasInternalVariable, fastSetInstanceVariable, fastSetInternalVariable, finishBasicObjectClass, forEachInstanceVariable, forEachInstanceVariableName, freeze, frozen_p, getCurrentContext, getFFIHandle, getFlag, getInstanceEvalClass, getInstanceEvalClass, getInstanceVariable, getInstanceVariableList, getInstanceVariableNameList, getInstanceVariables, getInternalVariable, getInternalVariables, getJavaClass, getMarshalVariableList, getMetaClass, getMetaClass, getNativeHandle, getNativeTypeIndex, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getSingletonClassCloneAndAttach, getSingletonClassCloneAndAttach, getType, getVariable, getVariableCount, getVariableList, getVariableNameList, hash, hash, hashyInspect, hasInstanceVariable, hasInstanceVariables, hasInternalVariable, hasVariables, id, infectBy, initialize, initialize_copy, inspect, inspectHashCode, instance_eval, instance_eval, instance_eval, instance_eval, instance_eval, instance_exec, instance_of_p, instance_variable_defined_p, instance_variable_get, instance_variable_set, instance_variables, isBuiltin, isClass, isFalse, isFrozen, isImmediate, isModule, isNil, isSpecialConst, isSpecialObject, isTaint, isTrue, isUntrusted, kind_of_p, makeMetaClass, makeMetaClass, makeMetaClassBootstrap, method, method, method, method_missing, methods, methods, nil_p, nonFixnumHashCode, nonFixnumHashCode, OBJ_INIT_COPY, objInitCopy, op_cmp, op_equal, op_match, op_not, op_not_equal, op_not_match, private_methods, protected_methods, public_methods, rbClone, rbClone, rbInspect, remove_instance_variable, removeFinalizers, removeInstanceVariable, removeInternalVariable, respond_to_p, respond_to_p, respondsTo, respondsToMissing, respondsToMissing, send, send, send, send, send, setFFIHandle, setFlag, setFrozen, setInstanceVariable, setInternalVariable, setMetaClass, setNativeHandle, setTaint, setUntrusted, setVariable, singleton_method, singleton_method, singleton_method_added, singleton_method_removed, singleton_method_undefined, singleton_methods, singletonClass, specificEval, specificEval, specificEval, specificEval, syncVariables, syncVariables, taint, taint, tainted_p, testFrozen, testFrozen, to_a, to_a, to_s, to_s, trust, type, untaint, untrust, untrusted_p, validateInstanceVariable, validateInstanceVariable, 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

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

checkStringType19, dup, marshalLiveVariables

Field Details

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 Details

RubyFile

public RubyFile(Ruby runtime,
 RubyClass type)

RubyFile

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

RubyFile

public RubyFile(Ruby runtime,
 String path,
 FileChannel channel)

Method Details

createFileClass

public static RubyClass createFileClass(ThreadContext context,
 RubyClass IO)

rbIoClose

protected IRubyObject rbIoClose(ThreadContext context)

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 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)

Overrides:

path in class RubyIO

truncate

public IRubyObject truncate(ThreadContext context,
 IRubyObject len)

inspect

public RubyString inspect(ThreadContext context)

Description copied from class: RubyBasicObject

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

basename

public static RubyString basename(ThreadContext context,
 IRubyObject recv,
 IRubyObject path)

basename

public static RubyString basename(ThreadContext context,
 IRubyObject recv,
 IRubyObject path,
 IRubyObject ext)

basename

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

Deprecated.

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 path)

dirname

public static IRubyObject dirname(ThreadContext context,
 IRubyObject recv,
 IRubyObject path,
 IRubyObject arg1)

dirname

public static String dirname(ThreadContext context,
 String filename)

dirname

public static String dirname(ThreadContext context,
 String filename,
 int level)

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 path)

Converts a pathname to an absolute pathname. Relative paths are referenced from the current working directory of the process.

Parameters:

recv -

path -

Returns:

Resulting absolute path as a String

expand_path

public static IRubyObject expand_path(ThreadContext context,
 IRubyObject recv,
 IRubyObject path,
 IRubyObject wd)

Converts a pathname to an absolute pathname. Relative paths are referenced from the given working directory. If the second argument is also relative, it will first be converted to an absolute pathname.

Parameters:

recv -

path -

wd -

Returns:

Resulting absolute path as a String

absolute_path

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

Converts a pathname to an absolute pathname. Relative paths are referenced from the current working directory of the process. If the given pathname starts with a ``+~+'' it is NOT expanded, it is treated as a normal directory name.

Parameters:

context -

recv -

path -

Returns:

absolute_path

public static IRubyObject absolute_path(ThreadContext context,
 IRubyObject recv,
 IRubyObject path,
 IRubyObject dir)

Converts a pathname to an absolute pathname. Relative paths are referenced from _dir_. If the given pathname starts with a ``+~+'' it is NOT expanded, it is treated as a normal directory name.

Parameters:

context -

recv -

path -

dir -

Returns:

absolute_path_p

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

realdirpath

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

realdirpath

public static IRubyObject realdirpath(ThreadContext context,
 IRubyObject recv,
 IRubyObject path,
 IRubyObject dir)

realpath

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

realpath

public static IRubyObject realpath(ThreadContext context,
 IRubyObject recv,
 IRubyObject path,
 IRubyObject cwd)

fnmatch

public static IRubyObject fnmatch(ThreadContext context,
 IRubyObject recv,
 IRubyObject _pattern,
 IRubyObject _path)

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: [...]).

fnmatch

public static IRubyObject fnmatch(ThreadContext context,
 IRubyObject recv,
 IRubyObject _pattern,
 IRubyObject _path,
 IRubyObject _flags)

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)

truncate19

@Deprecated
public static IRubyObject truncate19(ThreadContext context,
 IRubyObject recv,
 IRubyObject path,
 IRubyObject length)

Deprecated.

truncate

public static IRubyObject truncate(ThreadContext context,
 IRubyObject recv,
 IRubyObject path,
 IRubyObject length)

umask

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

lutime

public static IRubyObject lutime(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)

mkfifo

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

mkfifo

public static IRubyObject mkfifo(ThreadContext context,
 IRubyObject recv,
 IRubyObject path,
 IRubyObject mode)

mkfifo

public static IRubyObject mkfifo(ThreadContext context,
 RubyString path,
 int mode)

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)

getAdjustedPath

public static String getAdjustedPath(ThreadContext context,
 IRubyObject fileOrPath)

getAdjustedPath

public static String getAdjustedPath(ThreadContext context,
 IRubyObject fileOrPath,
 String currentDirectory)

get_path

public static RubyString get_path(ThreadContext context,
 IRubyObject path)

filePathConvert

protected static RubyString filePathConvert(ThreadContext context,
 RubyString path)

fileResource

public static FileResource fileResource(ThreadContext context,
 IRubyObject pathOrFile)

Get the fully-qualified JRubyFile object for the path, taking into account the runtime's current directory.

Parameters:

context - current thread context

pathOrFile - the string or IO to use for the path

fileResource

@Deprecated(since="9.4-")
public static FileResource fileResource(IRubyObject pathOrFile)

Deprecated.

Get the fully-qualified JRubyFile object for the path, taking into account the runtime's current directory. Same as calling fileResource(ThreadContext, IRubyObject)

Parameters:

pathOrFile - the string or IO to use for the path

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

Returns:

string representation

getDirOrFileEntry

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

Deprecated.

Throws:

IOException

getDirOrFileEntry

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

Deprecated.

Throws:

IOException

startsWithDriveLetterOnWindows

public static boolean startsWithDriveLetterOnWindows(String path)

expandPath

public static String expandPath(ThreadContext context,
 String relativePath,
 org.jcodings.Encoding[] enc,
 String cwd,
 boolean expandUser,
 boolean canonicalize)

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)

toJava

public <T> T toJava(Class<T> target)

Description copied from interface: IRubyObject

Convert the object to the specified Java class, if possible.

Specified by:

toJava in interface IRubyObject

Overrides:

toJava in class RubyIO

Type Parameters:

T - type

Parameters:

target - The target type to which the object should be converted.

Returns:

java type

See Also:

• IRubyObject.toJava(java.lang.Class<T>)

dirname

@Deprecated
public static IRubyObject dirname(ThreadContext context,
 IRubyObject recv,
 IRubyObject[] args)

Deprecated.

expand_path

@Deprecated
public static IRubyObject expand_path(ThreadContext context,
 IRubyObject recv,
 IRubyObject... args)

Deprecated.

absolute_path

@Deprecated
public static IRubyObject absolute_path(ThreadContext context,
 IRubyObject recv,
 IRubyObject[] args)

Deprecated.

realdirpath

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

Deprecated.

realpath

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

Deprecated.

fnmatch

@Deprecated
public static IRubyObject fnmatch(ThreadContext context,
 IRubyObject recv,
 IRubyObject[] args)

Deprecated.