Package org.jruby

Class RubyDir

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.RubyDir

All Implemented Interfaces:

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

public class RubyDir
extends RubyObject
implements Closeable

The Ruby built-in class Dir.

Author:

jvoegele

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

Field Summary

Fields

Modifier and Type	Field	Description
protected FileResource	dir

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
RubyDir(Ruby runtime, RubyClass type)

Method Summary

Modifier and Type	Method	Description
static IRubyObject	aref(ThreadContext context, IRubyObject recv, IRubyObject[] args)
IRubyObject	chdir(ThreadContext context, Block block)
static IRubyObject	chdir(ThreadContext context, IRubyObject recv, Block block)	Changes the current directory to path
static IRubyObject	chdir(ThreadContext context, IRubyObject recv, IRubyObject[] args, Block block)	Deprecated.
static IRubyObject	chdir(ThreadContext context, IRubyObject recv, IRubyObject path, Block block)	Changes the current directory to path
RubyArray	children(ThreadContext context)	Returns an array containing all of the filenames except for "." and ".." in the given directory.
static RubyArray	children(ThreadContext context, IRubyObject recv, IRubyObject arg)
static RubyArray	children(ThreadContext context, IRubyObject recv, IRubyObject arg, IRubyObject opts)
static IRubyObject	chroot(IRubyObject recv, IRubyObject path)	Deprecated.
static IRubyObject	chroot(ThreadContext context, IRubyObject recv, IRubyObject path)	Changes the root directory (only allowed by super user).
final void	close()	Deprecated.
IRubyObject	close(ThreadContext context)	Closes the directory stream.
static RubyClass	createDirClass(ThreadContext context, RubyClass Object, RubyModule Enumerable)
IRubyObject	each(ThreadContext context, org.jcodings.Encoding enc, Block block)	Executes the block once for each entry in the directory.
IRubyObject	each(ThreadContext context, Block block)	Executes the block once for each entry in the directory.
IRubyObject	each(ThreadContext context, IRubyObject encOpts, Block block)
IRubyObject	each_child(ThreadContext context, org.jcodings.Encoding enc, Block block)	Executes the block once for each child in the directory (i.e.
IRubyObject	each_child(ThreadContext context, Block block)	Executes the block once for each child in the directory (i.e.
static IRubyObject	each_child(ThreadContext context, IRubyObject recv, IRubyObject arg, Block block)	Executes the block once for each entry in the directory except for "." and "..", passing the filename of each entry as parameter to the block.
static IRubyObject	each_child(ThreadContext context, IRubyObject recv, IRubyObject arg, IRubyObject encOpts, Block block)	Executes the block once for each entry in the directory except for "." and "..", passing the filename of each entry as parameter to the block.
static IRubyObject	empty_p(ThreadContext context, IRubyObject recv, IRubyObject path)
RubyArray	entries()	Deprecated.
static RubyArray	entries(IRubyObject recv, IRubyObject path)	Deprecated.
static RubyArray	entries(IRubyObject recv, IRubyObject path, IRubyObject arg, IRubyObject opts)	Deprecated.
RubyArray	entries(ThreadContext context)
static RubyArray	entries(ThreadContext context, IRubyObject recv, IRubyObject arg)	Returns an array containing all of the filenames in the given directory.
static RubyArray	entries(ThreadContext context, IRubyObject recv, IRubyObject arg, IRubyObject opts)
static IRubyObject	exist(ThreadContext context, IRubyObject recv, IRubyObject arg)
static IRubyObject	exists_p(ThreadContext context, IRubyObject recv, IRubyObject arg)	Deprecated.
static IRubyObject	fchdir(ThreadContext context, IRubyObject dirClass, IRubyObject ignored)
IRubyObject	fileno(ThreadContext context)
static IRubyObject	for_fd(ThreadContext context, IRubyObject recv, IRubyObject ignored)
static IRubyObject	foreach(ThreadContext context, IRubyObject recv, IRubyObject path, Block block)	Executes the block once for each file in the directory specified by path.
static IRubyObject	foreach(ThreadContext context, IRubyObject recv, IRubyObject path, IRubyObject encOpts, Block block)
protected static List<String>	getContents(FileResource directory)	Deprecated. no longer used
protected static List<RubyString>	getContents(FileResource directory, Ruby runtime)	Deprecated. no longer used
protected static FileResource	getDir(Ruby runtime, String path, boolean mustExist)	Returns a Java File object for the specified path.
protected static JRubyFile	getDirForRmdir(Ruby runtime, String path)	Similar to getDir, but performs different checks to match rmdir behavior.
static RubyString	getHomeDirectoryPath(ThreadContext context)
static IRubyObject	getHomeDirectoryPath(ThreadContext context, String user)	Returns the home directory of the specified user on the system.
static Optional<String>	getHomeFromEnv(Ruby runtime)
String	getPath()
static RubyString	getwd(IRubyObject recv)	Deprecated.
static RubyString	getwd(ThreadContext context, IRubyObject recv)	Returns the current directory.
static IRubyObject	glob(ThreadContext context, IRubyObject recv, IRubyObject[] args, Block block)	Returns an array of filenames matching the specified wildcard pattern pat.
static IRubyObject	home(ThreadContext context, IRubyObject recv)	Returns the home directory of the current user or the named user if given.
static IRubyObject	home(ThreadContext context, IRubyObject recv, IRubyObject user)
static IRubyObject	home(ThreadContext context, IRubyObject recv, IRubyObject[] args)	Deprecated.
IRubyObject	initialize(ThreadContext context, IRubyObject path)	Creates a new Dir.
IRubyObject	initialize(ThreadContext context, IRubyObject path, IRubyObject encOpts)	Like initialize(ThreadContext, IRubyObject) but accepts an :encoding option.
IRubyObject	inspect(ThreadContext context)	Returns a string containing a human-readable representation of obj.
static IRubyObject	mkdir(IRubyObject recv, IRubyObject[] args)	Deprecated.
static IRubyObject	mkdir(ThreadContext context, IRubyObject recv, IRubyObject... args)	Creates the directory specified by path.
static IRubyObject	open(ThreadContext context, IRubyObject recv, IRubyObject path, Block block)	Returns a new directory object for path.
static IRubyObject	open(ThreadContext context, IRubyObject recv, IRubyObject path, IRubyObject encOpts, Block block)
IRubyObject	path(ThreadContext context)
IRubyObject	rb_each_child(ThreadContext context, Block block)
IRubyObject	read()	Deprecated.
IRubyObject	read(ThreadContext context)	Returns the next entry from this directory.
IRubyObject	rewind()	Deprecated.
IRubyObject	rewind(ThreadContext context)	Moves position in this directory to the first entry.
static IRubyObject	rmdir(IRubyObject recv, IRubyObject path)	Deprecated.
static IRubyObject	rmdir(ThreadContext context, IRubyObject recv, IRubyObject path)	Deletes the directory specified by path.
static IRubyObject	rmdir19(IRubyObject recv, IRubyObject path)	Deprecated.
IRubyObject	seek(IRubyObject newPos)	Deprecated.
IRubyObject	seek(ThreadContext context, IRubyObject newPos)	Moves to a position d.
IRubyObject	set_pos(IRubyObject newPos)	Deprecated.
IRubyObject	set_pos(ThreadContext context, IRubyObject newPos)
RubyInteger	tell()	Deprecated.
RubyInteger	tell(ThreadContext context)	Returns the current position in the directory.
IRubyObject	to_path(ThreadContext context)
<T> T	toJava(Class<T> target)	Convert the object to the specified Java class, if possible.

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, getNativeClassIndex, hashCode, inspect, op_eqq, puts, specificEval, toRubyString, toString

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

dir

protected FileResource dir

Constructor Details

RubyDir

public RubyDir(Ruby runtime,
 RubyClass type)

Method Details

createDirClass

public static RubyClass createDirClass(ThreadContext context,
 RubyClass Object,
 RubyModule Enumerable)

initialize

public IRubyObject initialize(ThreadContext context,
 IRubyObject path)

Creates a new Dir. This method takes a snapshot of the contents of the directory at creation time, so changes to the contents of the directory will not be reflected during the lifetime of the Dir object returned, so a new Dir instance must be created to reflect changes to the underlying file system.

Parameters:

context - current context

path - target path

Returns:

a new Dir object

initialize

public IRubyObject initialize(ThreadContext context,
 IRubyObject path,
 IRubyObject encOpts)

Like initialize(ThreadContext, IRubyObject) but accepts an :encoding option.

Parameters:

context - current context

path - target path

encOpts - encoding options

Returns:

a new Dir object

aref

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

glob

public static IRubyObject glob(ThreadContext context,
 IRubyObject recv,
 IRubyObject[] args,
 Block block)

Returns an array of filenames matching the specified wildcard pattern pat. If a block is given, the array is iterated internally with each filename is passed to the block in turn. In this case, Nil is returned.

entries

@Deprecated(since="10.0")
public RubyArray entries()

Deprecated.

entries

public RubyArray entries(ThreadContext context)

Returns:

all entries for this Dir

entries

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

Returns an array containing all of the filenames in the given directory.

entries

public static RubyArray entries(ThreadContext context,
 IRubyObject recv,
 IRubyObject arg,
 IRubyObject opts)

chdir

public static IRubyObject chdir(ThreadContext context,
 IRubyObject recv,
 IRubyObject path,
 Block block)

Changes the current directory to path

chdir

public static IRubyObject chdir(ThreadContext context,
 IRubyObject recv,
 Block block)

Changes the current directory to path

fchdir

public static IRubyObject fchdir(ThreadContext context,
 IRubyObject dirClass,
 IRubyObject ignored)

chdir

public IRubyObject chdir(ThreadContext context,
 Block block)

chroot

@Deprecated(since="10.0")
public static IRubyObject chroot(IRubyObject recv,
 IRubyObject path)

Deprecated.

chroot

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

Changes the root directory (only allowed by super user). Not available on all platforms.

children

public RubyArray children(ThreadContext context)

Returns an array containing all of the filenames except for "." and ".." in the given directory.

children

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

children

public static RubyArray children(ThreadContext context,
 IRubyObject recv,
 IRubyObject arg,
 IRubyObject opts)

rmdir

@Deprecated(since="10.0")
public static IRubyObject rmdir(IRubyObject recv,
 IRubyObject path)

Deprecated.

rmdir19

@Deprecated
public static IRubyObject rmdir19(IRubyObject recv,
 IRubyObject path)

Deprecated.

rmdir

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

Deletes the directory specified by path. The directory must be empty.

each_child

public static IRubyObject each_child(ThreadContext context,
 IRubyObject recv,
 IRubyObject arg,
 Block block)

Executes the block once for each entry in the directory except for "." and "..", passing the filename of each entry as parameter to the block.

each_child

public static IRubyObject each_child(ThreadContext context,
 IRubyObject recv,
 IRubyObject arg,
 IRubyObject encOpts,
 Block block)

Executes the block once for each entry in the directory except for "." and "..", passing the filename of each entry as parameter to the block.

foreach

public static IRubyObject foreach(ThreadContext context,
 IRubyObject recv,
 IRubyObject path,
 Block block)

Executes the block once for each file in the directory specified by path.

foreach

public static IRubyObject foreach(ThreadContext context,
 IRubyObject recv,
 IRubyObject path,
 IRubyObject encOpts,
 Block block)

getwd

@Deprecated(since="10.0")
public static RubyString getwd(IRubyObject recv)

Deprecated.

getwd

public static RubyString getwd(ThreadContext context,
 IRubyObject recv)

Returns the current directory.

home

public static IRubyObject home(ThreadContext context,
 IRubyObject recv)

Returns the home directory of the current user or the named user if given.

home

public static IRubyObject home(ThreadContext context,
 IRubyObject recv,
 IRubyObject user)

mkdir

public static IRubyObject mkdir(ThreadContext context,
 IRubyObject recv,
 IRubyObject... args)

Creates the directory specified by path. Note that the mode parameter is provided only to support existing Ruby code, and is ignored.

mkdir

@Deprecated
public static IRubyObject mkdir(IRubyObject recv,
 IRubyObject[] args)

Deprecated.

open

public static IRubyObject open(ThreadContext context,
 IRubyObject recv,
 IRubyObject path,
 Block block)

Returns a new directory object for path. If a block is provided, a new directory object is passed to the block, which closes the directory object before terminating.

open

public static IRubyObject open(ThreadContext context,
 IRubyObject recv,
 IRubyObject path,
 IRubyObject encOpts,
 Block block)

close

public IRubyObject close(ThreadContext context)

Closes the directory stream.

close

@Deprecated(since="10.0")
public final void close()

Deprecated.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

each

public IRubyObject each(ThreadContext context,
 org.jcodings.Encoding enc,
 Block block)

Executes the block once for each entry in the directory.

each

public IRubyObject each(ThreadContext context,
 Block block)

Executes the block once for each entry in the directory.

each

public IRubyObject each(ThreadContext context,
 IRubyObject encOpts,
 Block block)

each_child

public IRubyObject each_child(ThreadContext context,
 org.jcodings.Encoding enc,
 Block block)

Executes the block once for each child in the directory (i.e. all the directory entries except for "." and "..").

each_child

public IRubyObject each_child(ThreadContext context,
 Block block)

Executes the block once for each child in the directory (i.e. all the directory entries except for "." and "..").

rb_each_child

public IRubyObject rb_each_child(ThreadContext context,
 Block block)

inspect

public IRubyObject 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 RubyBasicObject

tell

public RubyInteger tell(ThreadContext context)

Returns the current position in the directory.

tell

@Deprecated
public RubyInteger tell()

Deprecated.

seek

@Deprecated(since="10.0")
public IRubyObject seek(IRubyObject newPos)

Deprecated.

seek

public IRubyObject seek(ThreadContext context,
 IRubyObject newPos)

Moves to a position d. pos must be a value returned by tell or 0.

set_pos

@Deprecated(since="10.0")
public IRubyObject set_pos(IRubyObject newPos)

Deprecated.

set_pos

public IRubyObject set_pos(ThreadContext context,
 IRubyObject newPos)

path

public IRubyObject path(ThreadContext context)

to_path

public IRubyObject to_path(ThreadContext context)

getPath

public String getPath()

read

@Deprecated(since="10.0")
public IRubyObject read()

Deprecated.

read

public IRubyObject read(ThreadContext context)

Returns the next entry from this directory.

rewind

@Deprecated(since="10.0")
public IRubyObject rewind()

Deprecated.

rewind

public IRubyObject rewind(ThreadContext context)

Moves position in this directory to the first entry.

empty_p

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

exist

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

exists_p

@Deprecated(since="10.0")
public static IRubyObject exists_p(ThreadContext context,
 IRubyObject recv,
 IRubyObject arg)

Deprecated.

fileno

public IRubyObject fileno(ThreadContext context)

for_fd

public static IRubyObject for_fd(ThreadContext context,
 IRubyObject recv,
 IRubyObject ignored)

getDir

protected static FileResource getDir(Ruby runtime,
 String path,
 boolean mustExist)

Returns a Java File object for the specified path. If path is not a directory, throws IOError.

Parameters:

path - path for which to return the File object.

mustExist - is true the directory must exist. If false it must not.

getDirForRmdir

protected static JRubyFile getDirForRmdir(Ruby runtime,
 String path)

Similar to getDir, but performs different checks to match rmdir behavior.

Parameters:

runtime -

path -

Returns:

getContents

@Deprecated(since="9.4-")
protected static List<String> getContents(FileResource directory)

Deprecated.

no longer used

getContents

@Deprecated(since="9.4-")
protected static List<RubyString> getContents(FileResource directory,
 Ruby runtime)

Deprecated.

no longer used

getHomeDirectoryPath

public static IRubyObject getHomeDirectoryPath(ThreadContext context,
 String user)

Returns the home directory of the specified user on the system. If the home directory of the specified user cannot be found, an ArgumentError it thrown.

getHomeDirectoryPath

public static RubyString getHomeDirectoryPath(ThreadContext context)

getHomeFromEnv

public static Optional<String> getHomeFromEnv(Ruby runtime)

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 RubyBasicObject

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

home

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

Deprecated.

entries

@Deprecated
public static RubyArray entries(IRubyObject recv,
 IRubyObject path)

Deprecated.

entries

@Deprecated
public static RubyArray entries(IRubyObject recv,
 IRubyObject path,
 IRubyObject arg,
 IRubyObject opts)

Deprecated.

chdir

@Deprecated
public static IRubyObject chdir(ThreadContext context,
 IRubyObject recv,
 IRubyObject[] args,
 Block block)

Deprecated.