org.jruby

Class RubyFile

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.RubyIO

org.jruby.RubyFile

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.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
private static int	_cachedUmask
private static java.lang.Object	_umaskLock
private java.nio.channels.FileLock	currentLock
private static ObjectAllocator	FILE_ALLOCATOR
private static int	FNM_CASEFOLD
private static int	FNM_DOTMATCH
private static int	FNM_NOESCAPE
private static int	FNM_PATHNAME
private static int	FNM_SYSCASE
static int	LOCK_EX
static int	LOCK_NB
static int	LOCK_SH
static int	LOCK_UN
protected java.lang.String	path
(package private) static java.util.regex.Pattern	PROTOCOL_PATTERN
private static java.util.regex.Pattern	ROOT_PATTERN
private static long	serialVersionUID
private static java.lang.String[]	SLASHES
private static java.util.regex.Pattern	URI_PREFIX

Fields inherited from class org.jruby.RubyIO

blockingThreads, ecflags, ecopts, enc, enc2, hasBom, openFile, popenSpecial, readconv, writeconv, writeconvAsciicompat, writeconvInitialized, writeconvPreEcflags, writeconvPreEcopts

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, metaClass, NEVER, NIL_F, STAMP_OFFSET, TAINTED_F, UNDEF, UNTRUSTED_F, USER0_F, USER1_F, USER2_F, USER3_F, USER4_F, USER5_F, USER6_F, USER7_F, USER8_F, VAR_TABLE_OFFSET, varTable, varTableStamp

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

NULL_ARRAY

Constructor Summary

Constructors

Constructor and Description
RubyFile(Ruby runtime, RubyClass type)
RubyFile(Ruby runtime, java.lang.String path, java.io.InputStream in)
RubyFile(Ruby runtime, java.lang.String path, java.io.Reader reader)

Method Summary

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.
(package private) static java.lang.String	adjustRootPathOnWindows(Ruby runtime, java.lang.String path, java.lang.String dir)
IRubyObject	atime(ThreadContext context)
static IRubyObject	atime(ThreadContext context, IRubyObject recv, IRubyObject filename)
static IRubyObject	basename(ThreadContext context, IRubyObject recv, IRubyObject[] args)
static java.lang.String	canonicalize(java.lang.String path)
private static java.lang.String	canonicalize(java.lang.String canonicalPath, java.lang.String remaining)
private void	checkClosed(ThreadContext context)
private static void	checkHome(ThreadContext context) Check if HOME environment variable is not nil nor empty
private static void	checkSharedExclusive(Ruby runtime, OpenFile openFile, int lockMode)
IRubyObject	chmod(ThreadContext context, IRubyObject arg)
static IRubyObject	chmod(ThreadContext context, IRubyObject recv, IRubyObject[] args)
private static void	chomp(java.lang.StringBuilder buffer)
IRubyObject	chown(ThreadContext context, IRubyObject arg1, IRubyObject arg2)
static IRubyObject	chown(ThreadContext context, IRubyObject recv, IRubyObject[] args)
private static java.lang.String	countSlashes(java.lang.String stringToCheck) Returns a string consisting of n-1 slashes, where n is the number of slashes at the beginning of the input string.
static RubyClass	createFileClass(Ruby runtime)
IRubyObject	ctime(ThreadContext context)
static IRubyObject	ctime(ThreadContext context, IRubyObject recv, IRubyObject filename)
static IRubyObject	dirname(ThreadContext context, IRubyObject recv, IRubyObject arg)
static java.lang.String	dirname(ThreadContext context, java.lang.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)
private static IRubyObject	expandPathInternal(ThreadContext context, IRubyObject recv, IRubyObject[] args, boolean expandUser, boolean canonicalize)
static java.lang.String	expandUserPath(ThreadContext context, java.lang.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 java.lang.String	expandUserPath(ThreadContext context, java.lang.String path, boolean raiseOnRelativePath)
static IRubyObject	extname(ThreadContext context, IRubyObject recv, IRubyObject arg) Returns the extension name of the file.
private static long[]	extractTimeval(Ruby runtime, IRubyObject value) Extract a timeval (an array of 2 longs: seconds and microseconds from epoch) from an IRubyObject.
static JRubyFile	file(IRubyObject pathOrFile) Deprecated.
IRubyObject	fileOpenGeneric(ThreadContext context, IRubyObject filename, int oflags, int fmode, IOEncodable convConfig, int perm)
private static RubyString	filePathConvert(ThreadContext context, RubyString path)
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 lockingConstant)
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.
private Stream	fopen(java.lang.String path, ModeFlags flags)
static IRubyObject	ftype(ThreadContext context, IRubyObject recv, IRubyObject filename)
static RubyString	get_path(ThreadContext context, IRubyObject path)
static java.util.zip.ZipEntry	getDirOrFileEntry(java.lang.String jar, java.lang.String path)
static java.util.zip.ZipEntry	getDirOrFileEntry(java.util.zip.ZipFile zf, java.lang.String path)
org.jcodings.Encoding	getEncoding()
static java.util.zip.ZipEntry	getFileEntry(java.util.zip.ZipFile zf, java.lang.String path)
private int	getFilePermissions(IRubyObject[] args)
private static java.lang.String	getNullDevice()
java.lang.String	getPath()
private static int	getUmaskSafe(Ruby runtime) Joy of POSIX, only way to get the umask is to set the umask, then set it back.
IRubyObject	initialize(IRubyObject[] args, Block block)
IRubyObject	initialize19(ThreadContext context, IRubyObject[] args, Block block)
IRubyObject	inspect() rb_obj_inspect call-seq: obj.inspect => string Returns a string containing a human-readable representation of obj.
private static java.lang.String	inspectJoin(ThreadContext context, IRubyObject recv, RubyArray parent, RubyArray array)
protected IRubyObject	ioClose(Ruby runtime)
private static boolean	isAbsolutePath(java.lang.String path)
private static boolean	isWindowsDriveLetter(char c)
static RubyString	join(ThreadContext context, IRubyObject recv, IRubyObject[] args)
private static RubyString	join(ThreadContext context, IRubyObject recv, RubyArray ary)
IRubyObject	lchmod(ThreadContext context, IRubyObject arg)
static IRubyObject	lchmod(ThreadContext context, IRubyObject recv, IRubyObject[] args)
IRubyObject	lchown(ThreadContext context, IRubyObject arg1, IRubyObject arg2)
static IRubyObject	lchown(ThreadContext context, IRubyObject recv, IRubyObject[] args)
static IRubyObject	link(ThreadContext context, IRubyObject recv, IRubyObject from, IRubyObject to)
private IRubyObject	lock(Ruby runtime, java.nio.channels.FileChannel fileChannel, boolean exclusive)
private static IRubyObject	lockFailedReturn(Ruby runtime, int lockMode)
private static boolean	lockStateChanges(java.nio.channels.FileLock lock, int lockMode)
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)
private IRubyObject	openFile(IRubyObject[] args)
private IRubyObject	openFile19(ThreadContext context, IRubyObject[] args)
protected void	openInternal(java.lang.String path, java.lang.String modeString)
IRubyObject	path(ThreadContext context)
static IRubyObject	path(ThreadContext context, IRubyObject self, IRubyObject str)
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 java.lang.String[]	splitURI(java.lang.String path)
static boolean	startsWithDriveLetterOnWindows(java.lang.String path)
IRubyObject	stat(ThreadContext context)
static IRubyObject	stat(ThreadContext context, IRubyObject recv, IRubyObject filename)
static IRubyObject	symlink(ThreadContext context, IRubyObject recv, IRubyObject from, IRubyObject to)
private ChannelDescriptor	sysopen(java.lang.String path, ModeFlags modes, int perm)
protected void	sysopenInternal(java.lang.String path, ModeFlags modes, int perm)
protected void	sysopenInternal19(java.lang.String path, int oflags, int perm)
java.lang.String	toString() The default toString method is just a wrapper that calls the Ruby "to_s" method.
IRubyObject	truncate(ThreadContext context, IRubyObject arg)
static IRubyObject	truncate(ThreadContext context, IRubyObject recv, IRubyObject arg1, IRubyObject arg2)
static IRubyObject	truncate19(ThreadContext context, IRubyObject recv, IRubyObject arg1, IRubyObject arg2)
private static IRubyObject	truncateCommon(ThreadContext context, IRubyObject recv, IRubyObject arg1, IRubyObject arg2)
private IRubyObject	tryLock(Ruby runtime, java.nio.channels.FileChannel fileChannel, boolean exclusive)
static IRubyObject	umask(ThreadContext context, IRubyObject recv, IRubyObject[] args)
static IRubyObject	unlink(ThreadContext context, IRubyObject recv, IRubyObject[] args)
private IRubyObject	unlock(Ruby runtime)
static IRubyObject	utime(ThreadContext context, IRubyObject recv, IRubyObject[] args)

Methods inherited from class org.jruby.RubyIO

addBlockingThread, autoclose_set, autoclose, binmode, binread, binwrite, bytes, chars, chars19, checkExecOptions, checkPipeCommand, checkPopenOptions, checkSpawnOptions, 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_charInternal19, each_codepoint, each_line, each_lineInternal, each, emptyBufferOrEOF, encodingFromBOM, eof_p, external_encoding, failIfDirectory, fcntl, fcntl, fdopen, fileno, flush, foreach, foreach19, fsync, fwrite, getBlocking, getBOM, getbyte19, getc, getc19, getcCommon, getChannel, getDescriptorByFileno, getEcflags, getEcopts, getEnc, getEnc2, getHandler, getInputEncoding, getInStream, getIOModes, getIOModesIntFromString, getline, getline, getline, getline, getNativeTypeIndex, getNewFileno, getOpenFile, getOpenFileChecked, getOutStream, getReadEncoding, gets, gets, gets, gets19, gets19, gets19, initialize_copy, initialize19, initialize19, initialize19, internal_encoding, interruptBlockingThreads, ioctl, ioOpen, 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, parseIOOptions19, pid, pipe, pipe19, pipe19, pipe19, popen, popen19, popen3_19, popen3, popen4, popenSpecial, pos_set, pos, print, print, print19, printf, putc, putc, puts, puts, puts, puts, puts, puts, puts0, puts1, puts2, puts3, read_nonblock, read, read, read, read, read, read, read, read, read19, readAll, readAll, readAllCommon, readbyte, readchar, readchar19, readline, readline, readline, readlines, readlines, readlines19, readlines19, readpartial, readStatic, readStatic, readStatic, registerDescriptor, registerDescriptor, removeBlockingThread, reopen, reopenIO, reopenPath, restartSystemCall, rewind, seek, seek, seek, select_static, select, set_encoding, set_encoding, set_encoding, setAscii8bitBinmode, setAutoclose, setBOM, setEcflags, setEcopts, setEnc, setEnc2, setEncoding, swallow, sync_set, sync, sysopen, sysopen19, sysread, sysseek, syswrite, to_io, tryConvert, tty_p, ungetc, ungetc19, ungetcCommon, unregisterDescriptor, updateIOOptionsFromOptions, write_nonblock, write, write, write, write, writeDataBuffered, 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, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getType, getVariable, getVariableCount, getVariableList, getVariableNameList, hash, hashyInspect, hasInstanceVariable, hasInternalVariable, hasVariables, id_deprecated, id, infectBy, infectBy, 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, isTaint, isTrue, isUntrusted, kind_of_p, makeMetaClass, method_missing19, method, method19, methods, methods, methods19, nil_p, 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, recacheBuiltinMethods, 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, singleton_methods19, 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

FILE_ALLOCATOR

private static ObjectAllocator FILE_ALLOCATOR

ROOT_PATTERN

private static java.util.regex.Pattern ROOT_PATTERN

PROTOCOL_PATTERN

static java.util.regex.Pattern PROTOCOL_PATTERN

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

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

FNM_NOESCAPE

private static final int FNM_NOESCAPE

See Also:

Constant Field Values

FNM_PATHNAME

private static final int FNM_PATHNAME

See Also:

Constant Field Values

FNM_DOTMATCH

private static final int FNM_DOTMATCH

See Also:

Constant Field Values

FNM_CASEFOLD

private static final int FNM_CASEFOLD

See Also:

Constant Field Values

FNM_SYSCASE

private static final int FNM_SYSCASE

_cachedUmask

private static int _cachedUmask

_umaskLock

private static final java.lang.Object _umaskLock

SLASHES

private static final java.lang.String[] SLASHES

URI_PREFIX

private static java.util.regex.Pattern URI_PREFIX

path

protected java.lang.String path

currentLock

private volatile java.nio.channels.FileLock currentLock

Constructor Detail

RubyFile

public RubyFile(Ruby runtime,
                RubyClass type)

RubyFile

public RubyFile(Ruby runtime,
                java.lang.String path,
                java.io.Reader reader)

RubyFile

public RubyFile(Ruby runtime,
                java.lang.String path,
                java.io.InputStream in)

Method Detail

createFileClass

public static RubyClass createFileClass(Ruby runtime)

getNullDevice

private static java.lang.String getNullDevice()

ioClose

protected IRubyObject ioClose(Ruby runtime)

Overrides:

ioClose in class RubyIO

flock

public IRubyObject flock(ThreadContext context,
                         IRubyObject lockingConstant)

initialize

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

Overrides:

initialize in class RubyIO

initialize19

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

lchmod

public IRubyObject lchmod(ThreadContext context,
                          IRubyObject arg)

lchown

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

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)

stat

public IRubyObject stat(ThreadContext context)

Overrides:

stat in class RubyIO

truncate

public IRubyObject truncate(ThreadContext context,
                            IRubyObject arg)

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 java.lang.String dirname(ThreadContext context,
                                       java.lang.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)

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)

unlink

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

size

public IRubyObject size(ThreadContext context)

getPath

public java.lang.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

openFile19

private IRubyObject openFile19(ThreadContext context,
                               IRubyObject[] args)

fileOpenGeneric

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

openFile

private IRubyObject openFile(IRubyObject[] args)

getFilePermissions

private int getFilePermissions(IRubyObject[] args)

sysopenInternal

protected void sysopenInternal(java.lang.String path,
                               ModeFlags modes,
                               int perm)

sysopenInternal19

protected void sysopenInternal19(java.lang.String path,
                                 int oflags,
                                 int perm)

openInternal

protected void openInternal(java.lang.String path,
                            java.lang.String modeString)

sysopen

private ChannelDescriptor sysopen(java.lang.String path,
                                  ModeFlags modes,
                                  int perm)

fopen

private Stream fopen(java.lang.String path,
                     ModeFlags flags)

get_path

public static RubyString get_path(ThreadContext context,
                                  IRubyObject path)

filePathConvert

private static RubyString filePathConvert(ThreadContext context,
                                          RubyString 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 java.lang.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 java.util.zip.ZipEntry getFileEntry(java.util.zip.ZipFile zf,
                                                  java.lang.String path)
                                           throws java.io.IOException

Throws:

java.io.IOException

getDirOrFileEntry

public static java.util.zip.ZipEntry getDirOrFileEntry(java.lang.String jar,
                                                       java.lang.String path)
                                                throws java.io.IOException

Throws:

java.io.IOException

getDirOrFileEntry

public static java.util.zip.ZipEntry getDirOrFileEntry(java.util.zip.ZipFile zf,
                                                       java.lang.String path)
                                                throws java.io.IOException

Throws:

java.io.IOException

isAbsolutePath

private static boolean isAbsolutePath(java.lang.String path)

startsWithDriveLetterOnWindows

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

adjustRootPathOnWindows

static java.lang.String adjustRootPathOnWindows(Ruby runtime,
                                                java.lang.String path,
                                                java.lang.String dir)

getUmaskSafe

private static int getUmaskSafe(Ruby runtime)

Joy of POSIX, only way to get the umask is to set the umask, then set it back. That's unsafe in a threaded program. We minimize but may not totally remove this race by caching the obtained or previously set (see umask() above) umask and using that as the initial set value which, cross fingers, is a no-op. The cache access is then synchronized. TODO: Better?

extractTimeval

private static long[] extractTimeval(Ruby runtime,
                                     IRubyObject value)

Extract a timeval (an array of 2 longs: seconds and microseconds from epoch) from an IRubyObject.

checkClosed

private void checkClosed(ThreadContext context)

isWindowsDriveLetter

private static boolean isWindowsDriveLetter(char c)

expandPathInternal

private static IRubyObject expandPathInternal(ThreadContext context,
                                              IRubyObject recv,
                                              IRubyObject[] args,
                                              boolean expandUser,
                                              boolean canonicalize)

splitURI

public static java.lang.String[] splitURI(java.lang.String path)

expandUserPath

public static java.lang.String expandUserPath(ThreadContext context,
                                              java.lang.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 java.lang.String expandUserPath(ThreadContext context,
                                              java.lang.String path,
                                              boolean raiseOnRelativePath)

countSlashes

private static java.lang.String countSlashes(java.lang.String stringToCheck)

Returns a string consisting of n-1 slashes, where n is the number of slashes at the beginning of the input string.

Parameters:

stringToCheck -

Returns:

canonicalize

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

canonicalize

private static java.lang.String canonicalize(java.lang.String canonicalPath,
                                             java.lang.String remaining)

checkHome

private static void checkHome(ThreadContext context)

Check if HOME environment variable is not nil nor empty

Parameters:

context -

inspectJoin

private static java.lang.String inspectJoin(ThreadContext context,
                                            IRubyObject recv,
                                            RubyArray parent,
                                            RubyArray array)

join

private static RubyString join(ThreadContext context,
                               IRubyObject recv,
                               RubyArray ary)

chomp

private static void chomp(java.lang.StringBuilder buffer)

truncateCommon

private static IRubyObject truncateCommon(ThreadContext context,
                                          IRubyObject recv,
                                          IRubyObject arg1,
                                          IRubyObject arg2)

checkSharedExclusive

private static void checkSharedExclusive(Ruby runtime,
                                         OpenFile openFile,
                                         int lockMode)

lockFailedReturn

private static IRubyObject lockFailedReturn(Ruby runtime,
                                            int lockMode)

lockStateChanges

private static boolean lockStateChanges(java.nio.channels.FileLock lock,
                                        int lockMode)

unlock

private IRubyObject unlock(Ruby runtime)
                    throws java.io.IOException

Throws:

java.io.IOException

lock

private IRubyObject lock(Ruby runtime,
                         java.nio.channels.FileChannel fileChannel,
                         boolean exclusive)
                  throws java.io.IOException

Throws:

java.io.IOException

tryLock

private IRubyObject tryLock(Ruby runtime,
                            java.nio.channels.FileChannel fileChannel,
                            boolean exclusive)
                     throws java.io.IOException

Throws:

java.io.IOException