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

Direct Known Subclasses:

Tempfile

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.Sysopen

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
(package private) static final ByteList	BACKSLASH
private static final int	FNM_CASEFOLD
private static final int	FNM_DOTMATCH
private static final int	FNM_EXTGLOB
private static final int	FNM_NOESCAPE
private static final int	FNM_PATHNAME
private static final int	FNM_SYSCASE
static final int	LOCK_EX
static final int	LOCK_NB
static final int	LOCK_SH
static final int	LOCK_UN
private static final int	NULL_CHAR
protected String	path	Deprecated.
(package private) static final Pattern	PROTOCOL_PATTERN
private static final Pattern	PROTOCOL_PREFIX_PATTERN
private static final Pattern	ROOT_PATTERN
private static final long	serialVersionUID
(package private) static final ByteList	SLASH
private static final String[]	SLASHES
private static final Pattern	URI_PREFIX
private static final String	URI_PREFIX_STRING

Fields inherited from class org.jruby.RubyIO

ALL_SPAWN_OPTIONS, CLOSED_STREAM_MSG, FD_CLOEXEC, openFile, PARAGRAPH_SEPARATOR, popenSpecial, UNSUPPORTED_SPAWN_OPTIONS

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

Constructor Summary

Constructors

Constructor	Description
RubyFile(Ruby runtime, String path, InputStream in)
RubyFile(Ruby runtime, String path, Reader reader)
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[] 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.
private static String	adjustPostFixDotDot(String postFix)
(package private) static String	adjustRootPathOnWindows(Ruby runtime, String path, String dir)
private static StringBuilder	appendSlash(CharSequence canonicalPath)
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)
private static RubyString	basenameImpl(ThreadContext context, RubyClass klass, IRubyObject path, IRubyObject ext)
IRubyObject	birthtime(ThreadContext context)
static IRubyObject	birthtime(ThreadContext context, IRubyObject recv, IRubyObject filename)
private static CharSequence	canonicalize(CharSequence canonicalPath, String remaining)
static String	canonicalize(String path)
private static String	canonicalizePath(String path)
private static String	canonicalNormalized(CharSequence realPath)
private void	checkClosed(ThreadContext context)
private static RubyString	checkHome(ThreadContext context)	Check if HOME environment variable is not nil nor empty
IRubyObject	chmod(ThreadContext context, IRubyObject arg)
static IRubyObject	chmod(ThreadContext context, IRubyObject recv, IRubyObject[] args)
private static int	chomp(StringBuilder buffer)
IRubyObject	chown(ThreadContext context, IRubyObject arg1, IRubyObject arg2)
static IRubyObject	chown(ThreadContext context, IRubyObject recv, IRubyObject[] args)
private static String	concatStrings(String s1, CharSequence s2, String s3)
private static long[]	convertTimespecToTimeval(long[] timespec)	Converts a timespec (array of 2 longs: seconds and nanoseconds from epoch) into a timeval (array of 2 longs: seconds and microseconds from epoch).
private static String	countSlashes(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	delete(ThreadContext context, IRubyObject recv, IRubyObject[] args)
private static boolean	dir_fnmatch(ByteList pattern, ByteList path, int flags)
static String	dirname(ThreadContext context, String filename)
static IRubyObject	dirname(ThreadContext context, IRubyObject recv, IRubyObject arg)
private static RubyString	doJoin(ThreadContext context, IRubyObject recv, IRubyObject[] args)
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)	Deprecated.
static String	expandPath(ThreadContext context, String relativePath, org.jcodings.Encoding[] enc, String cwd, boolean expandUser, boolean canonicalize)
(package private) static RubyString	expandPathInternal(ThreadContext context, RubyString path, RubyString wd, boolean expandUser, boolean canonicalize)
private static RubyString	expandPathInternal(ThreadContext context, IRubyObject[] args, 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.
private static long[]	extractTimespec(ThreadContext context, IRubyObject value)	Extract a timespec (an array of 2 longs: seconds and nanoseconds 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)	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)	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 String	getAdjustedPath(ThreadContext context, IRubyObject fileOrPath)
static String	getAdjustedPath(ThreadContext context, IRubyObject fileOrPath, String currentDirectory)
private static int	getAltSeparatorChar(RubyClass File)
static final FileTime	getBirthtimeWithNIO(String pathString)
private static String	getDecodedPath(ThreadContext context, IRubyObject pathOrFile)
static ZipEntry	getDirOrFileEntry(String jar, String path)	Deprecated.
static ZipEntry	getDirOrFileEntry(ZipFile jar, String path)	Deprecated.
org.jcodings.Encoding	getEncoding()
private static ZipEntry	getFileEntry(ZipFile jar, String path, String prefixForNoEntry)
private static String	getNullDevice()
String	getPath()
private static int	getSeparatorChar(RubyClass File)
(package private) final long	getSize(ThreadContext context)
IRubyObject	initialize(ThreadContext context, IRubyObject[] args, Block block)
IRubyObject	initialize19(IRubyObject[] args, Block block)	Deprecated.
final IRubyObject	inspect()	rb_obj_inspect call-seq: obj.inspect => string Returns a string containing a human-readable representation of obj.
RubyString	inspect(ThreadContext context)
private static boolean	isAbsolutePath(String path)
private static boolean	isDirSeparator(char c)
private static boolean	isLocalURI(String canonicalPathString)
private static boolean	isSymlink(ThreadContext context, JRubyFile file)
private static boolean	isWindowsDriveLetter(char c)
static RubyString	join(ThreadContext context, IRubyObject recv, IRubyObject[] args)
private static boolean	joinImpl(StringBuilder buffer, String separator, ThreadContext context, IRubyObject recv, RubyArray args)
private static StringBuilder	joinImplInspecting(String separator, ThreadContext context, IRubyObject recv, RubyArray parent, RubyArray array)
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[] args)
static IRubyObject	realpath(ThreadContext context, IRubyObject recv, IRubyObject path)
static IRubyObject	realpath(ThreadContext context, IRubyObject recv, IRubyObject[] args)
static IRubyObject	realpath(ThreadContext context, IRubyObject recv, IRubyObject path, IRubyObject cwd)
static IRubyObject	rename(ThreadContext context, IRubyObject recv, IRubyObject oldName, IRubyObject newName)
private static String	replace(String str, CharSequence target, CharSequence replace)
void	setEncoding(org.jcodings.Encoding encoding)
private void	setPath(String path)
private static JavaSites.FileSites	sites(ThreadContext context)
IRubyObject	size(ThreadContext context)
static RubyArray	split(ThreadContext context, IRubyObject recv, IRubyObject arg)
static String[]	splitURI(String path)
(package private) static boolean	startsWithDriveLetterOnWindows(CharSequence 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 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)
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, adviceArgCheck, advise, autoclose, autoclose_set, binmode, binread, binwrite, bytes, chars, chars19, checkExecEnv, checkExecOptions, checkLength, checkPopenOptions, checkSpawnOptions, checkUnsupportedOptions, checkValidSpawnOptions, cloexecOpen, close, close, close_on_exec_p, close_on_exec_set, close_read, close_write, closed_p, codepoints, convertToIO, copy_stream, createIOClass, doRead, doReadNonblock, doWriteNonblock, each, each, each, each, each, each_byte, each_byteInternal, each_char, each_char19, 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, getc19, getChannel, getEcflags, getEcopts, getEnc, getEnc2, getInputEncoding, getInStream, getIOModes, getIOModesIntFromString, getline, getline, getline, getline, getline, getline, getNativeClassIndex, getOpenFile, getOpenFileChecked, getOpenFileInitialized, getOutStream, getPartial, getReadEncoding, gets, gets, gets, gets, getSync, GetWriteIO, initialize, initialize, initialize, initialize_copy, internal_encoding, ioClose, ioctl, ioOpen, ioOpen, ioOpen, ioStaticWrite, isAutoclose, isClosed, lineno, lineno_set, lines, lines19, MakeOpenFile, newInstance, newIO, newIOOptions, newIOOptions, newIOOptions, newIOOptions, newIOOptions, newModeFlags, newModeFlags, newModeFlags, nonblockEOF, obliterateProcess, op_append, op_binmode, open, parseIOOptions, pid, pipe, pipe, pipe19, pipe19, pipe19, popen, popen3, popen4, popenSpecial, pos, pos_set, pread, pread, prepStdio, prepStdio, print, print, printf, putc, putc, puts, puts, puts, puts, puts, puts, puts0, puts1, puts2, puts3, pwrite, read, read, read, read, read, read, read, read_nonblock, read19, readbyte, readchar, readchar, readline, readline, readline, readlines, readlines, readlines, readlines, readlines, readlines, readlines19, readlines19, readpartial, removeBlockingThread, reopen, reopenIO, rewind, seek, seek, seek, seekBeforeAccess, select, select_static, set_encoding, set_encoding, set_encoding, setAscii8bitBinmode, setAutoclose, setBlocking, setBOM, setEcflags, setEcopts, setEnc, setEnc2, setEncoding, setSync, stat, sync, sync_set, sysopen, sysopen, sysopen, sysopen19, sysread, sysseek, syswrite, to_io, tryConvert, tty_p, ungetbyte, ungetc, updateIOOptionsFromOptions, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write_nonblock, writeStatic

Methods inherited from class org.jruby.RubyObject

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

Methods inherited from class org.jruby.RubyBasicObject

addFinalizer, anyToString, asJavaString, asString, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callSuper, checkArrayType, checkCallMethod, checkCallMethod, checkFrozen, checkStringType, checkStringType19, compareTo, convertToArray, convertToFloat, convertToHash, convertToInteger, convertToInteger, convertToInteger, convertToString, copyInstanceVariablesInto, copySpecialInstanceVariables, createBasicObjectClass, dataGetStruct, dataGetStructChecked, dataWrapStruct, decode, defaultToJava, display, dup, ensureInstanceVariablesSettable, eql, eql_p, 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, getMetaClass, getNativeHandle, getNativeTypeIndex, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getSingletonClassCloneAndAttach, getType, getVariable, getVariableCount, getVariableList, getVariableNameList, hash, hashyInspect, hasInstanceVariable, hasInstanceVariables, hasInternalVariable, hasVariables, id, infectBy, infectBy, infectBy, initialize, 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, isSpecialObject, isTaint, isTrue, isUntrusted, kind_of_p, makeMetaClass, method, method_missing, method_missing19, method19, methods, methods, methods19, methodsImpl, nil_p, nonFixnumHashCode, OBJ_INIT_COPY, objInitCopy, op_cmp, op_equal, op_equal_19, op_match, op_match19, op_not, op_not_equal, op_not_match, private_methods, private_methods19, protected_methods, protected_methods19, public_methods, public_methods19, rbClone, rbClone, rbInspect, recacheBuiltinMethods, remove_instance_variable, removeFinalizers, removeInstanceVariable, removeInternalVariable, respond_to_p, 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, singleton_method_added, singleton_method_added19, singleton_method_removed, singleton_method_removed19, singleton_method_undefined, singleton_method_undefined19, singleton_methods, specificEval, specificEval, specificEval, specificEval, syncVariables, syncVariables, taint, taint, tainted, tainted_p, testFrozen, testFrozen, to_a, to_a, to_s, trust, type, type_deprecated, 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

Field Details

SLASH

static final ByteList SLASH

BACKSLASH

static final ByteList BACKSLASH

URI_PREFIX_STRING

private static final String URI_PREFIX_STRING

See Also:

• Constant Field Values

ROOT_PATTERN

private static final Pattern ROOT_PATTERN

NULL_CHAR

private static final int NULL_CHAR

See Also:

• Constant Field Values

PROTOCOL_PATTERN

static final Pattern PROTOCOL_PATTERN

PROTOCOL_PREFIX_PATTERN

private static final Pattern PROTOCOL_PREFIX_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_EXTGLOB

private static final int FNM_EXTGLOB

See Also:

• Constant Field Values

FNM_SYSCASE

private static final int FNM_SYSCASE

SLASHES

private static final String[] SLASHES

URI_PREFIX

private static final Pattern URI_PREFIX

path

@Deprecated
protected String path

Deprecated.

Constructor Details

RubyFile

public RubyFile(Ruby runtime,
 RubyClass type)

RubyFile

RubyFile(Ruby runtime,
 String path,
 Reader reader)

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(Ruby runtime)

getNullDevice

private static String getNullDevice()

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)

truncate

public IRubyObject truncate(ThreadContext context,
 IRubyObject len)

inspect

public final 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

inspect

public RubyString inspect(ThreadContext context)

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.

basenameImpl

private static RubyString basenameImpl(ThreadContext context,
 RubyClass klass,
 IRubyObject path,
 IRubyObject ext)

getSeparatorChar

private static int getSeparatorChar(RubyClass File)

getAltSeparatorChar

private static int getAltSeparatorChar(RubyClass File)

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

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

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

Deprecated.

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)

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

dir_fnmatch

private static boolean dir_fnmatch(ByteList pattern,
 ByteList path,
 int 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)

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)

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)

isSymlink

private static boolean isSymlink(ThreadContext context,
 JRubyFile file)

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)

getSize

final long getSize(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)

getPath

public String getPath()

setPath

private void setPath(String path)

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

private 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

public static FileResource fileResource(IRubyObject pathOrFile)

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

getDecodedPath

private static String getDecodedPath(ThreadContext context,
 IRubyObject pathOrFile)

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

private static ZipEntry getFileEntry(ZipFile jar,
 String path,
 String prefixForNoEntry)
                              throws IOException

Throws:

IOException

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

isAbsolutePath

private static boolean isAbsolutePath(String path)

isWindowsDriveLetter

private static boolean isWindowsDriveLetter(char c)

startsWithDriveLetterOnWindows

public static boolean startsWithDriveLetterOnWindows(String path)

startsWithDriveLetterOnWindows

static boolean startsWithDriveLetterOnWindows(CharSequence path)

adjustRootPathOnWindows

static String adjustRootPathOnWindows(Ruby runtime,
 String path,
 String dir)

extractTimespec

private static long[] extractTimespec(ThreadContext context,
 IRubyObject value)

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

convertTimespecToTimeval

private static long[] convertTimespecToTimeval(long[] timespec)

Converts a timespec (array of 2 longs: seconds and nanoseconds from epoch) into a timeval (array of 2 longs: seconds and microseconds from epoch). This is needed because calling methods like utimensat() allows nanosecond precision, while the older utimes() only supports microsecond precision.

checkClosed

private void checkClosed(ThreadContext context)

expandPathInternal

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

expandPathInternal

static RubyString expandPathInternal(ThreadContext context,
 RubyString path,
 RubyString wd,
 boolean expandUser,
 boolean canonicalize)

expandPath

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

canonicalNormalized

private static String canonicalNormalized(CharSequence realPath)

adjustPostFixDotDot

private static String adjustPostFixDotDot(String postFix)

concatStrings

private static String concatStrings(String s1,
 CharSequence s2,
 String s3)

canonicalizePath

private static String canonicalizePath(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)

countSlashes

private static String countSlashes(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 String canonicalize(String path)

canonicalize

private static CharSequence canonicalize(CharSequence canonicalPath,
 String remaining)

isLocalURI

private static boolean isLocalURI(String canonicalPathString)

appendSlash

private static StringBuilder appendSlash(CharSequence canonicalPath)

checkHome

private static RubyString checkHome(ThreadContext context)

Check if HOME environment variable is not nil nor empty

Parameters:

context -

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

Parameters:

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

See Also:

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

doJoin

private static RubyString doJoin(ThreadContext context,
 IRubyObject recv,
 IRubyObject[] args)

joinImpl

private static boolean joinImpl(StringBuilder buffer,
 String separator,
 ThreadContext context,
 IRubyObject recv,
 RubyArray args)

joinImplInspecting

private static StringBuilder joinImplInspecting(String separator,
 ThreadContext context,
 IRubyObject recv,
 RubyArray parent,
 RubyArray array)

isDirSeparator

private static boolean isDirSeparator(char c)

chomp

private static int chomp(StringBuilder buffer)

replace

private static String replace(String str,
 CharSequence target,
 CharSequence replace)

truncateCommon

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

sites

private static JavaSites.FileSites sites(ThreadContext context)

initialize19

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

Deprecated.