JRuby Base 10.0.0.0 · org.jruby.RubyDir · APIdia, the JavaDoc alternative

Modifier and Type	Class and Description
private static class	RubyDir.GlobOptions

Modifier and Type	Field and Description
private static final String[]	BASE_FLAGS_KEYWORDS
private static final String[]	BASE_KEYWORDS
protected FileResource	dir
private Encoding	encoding
pack-priv static final ByteList	HOME
private boolean	isOpen
private long	lastModified
private static final String[]	NO_FILES
private RubyString	path
private int	pos
private String[]	snapshot
private static final ByteList	user_home

Access	Constructor and Description
public	RubyDir(Ruby runtime, RubyClass type)

Method Summary

Modifier and Type	Method and Description
public static IRubyObject	aref(ThreadContext context, IRubyObject recv, IRubyObject[] args)
private static RubyArray<T extends IRubyObject>	asRubyStringList(Ruby runtime, List<ByteList> dirs)
public static IRubyObject	chdir(ThreadContext context, IRubyObject recv, IRubyObject path, Block block) Changes the current directory to `path`
public static IRubyObject	chdir(ThreadContext context, IRubyObject recv, Block block) Changes the current directory to `path`
public IRubyObject	chdir(ThreadContext context, Block block)
public static IRubyObject	chdir(ThreadContext context, IRubyObject recv, IRubyObject[] args, Block block) Deprecated
private static IRubyObject	chdirCommon(ThreadContext context, Block block, RubyString path, boolean yieldPath)
private void	checkDir(ThreadContext context)
private void	checkDirIgnoreClosed(ThreadContext context)
private static void	checkDirIsTwoSlashesOnWindows(Ruby runtime, String path)
public RubyArray<T extends IRubyObject>	children(ThreadContext context) Returns an array containing all of the filenames except for "." and ".." in the given directory.
public static RubyArray<T extends IRubyObject>	children(ThreadContext context, IRubyObject recv, IRubyObject arg)
public static RubyArray<T extends IRubyObject>	children(ThreadContext context, IRubyObject recv, IRubyObject arg, IRubyObject opts)
public static IRubyObject	chroot(IRubyObject recv, IRubyObject path) Deprecated since 10.0.
public static IRubyObject	chroot(ThreadContext context, IRubyObject recv, IRubyObject path) Changes the root directory (only allowed by super user).
public IRubyObject	close(ThreadContext context) Closes the directory stream.
public final void	close() Implements java.io.Closeable.close. Deprecated since 10.0. Closes this stream and releases any system resources associated with it.
public static RubyClass	createDirClass(ThreadContext context, RubyClass Object, RubyModule Enumerable)
private static String	dirFromPath(final String path, final Ruby runtime)
private static ArrayList<ByteList>	dirGlobs(ThreadContext context, String cwd, IRubyObject[] args, int flags, boolean sort)
public IRubyObject	each(ThreadContext context, Encoding enc, Block block) Executes the block once for each entry in the directory.
public IRubyObject	each(ThreadContext context, Block block) Executes the block once for each entry in the directory.
public IRubyObject	each(ThreadContext context, IRubyObject encOpts, Block block)
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.
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.
public IRubyObject	each_child(ThreadContext context, Encoding enc, Block block) Executes the block once for each child in the directory (i.e. all the directory entries except for "." and "..").
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 "..").
private static IRubyObject	eachChildCommon(ThreadContext context, IRubyObject recv, RubyString path, IRubyObject encOpts, Block block)
public static IRubyObject	empty_p(ThreadContext context, IRubyObject recv, IRubyObject path)
public RubyArray<T extends IRubyObject>	entries() Deprecated since 10.0.
public RubyArray<T extends IRubyObject>	Returns: all entries for this Dir entries(ThreadContext context)
public static RubyArray<T extends IRubyObject>	entries(ThreadContext context, IRubyObject recv, IRubyObject arg) Returns an array containing all of the filenames in the given directory.
public static RubyArray<T extends IRubyObject>	entries(ThreadContext context, IRubyObject recv, IRubyObject arg, IRubyObject opts)
public static RubyArray<T extends IRubyObject>	entries(IRubyObject recv, IRubyObject path) Deprecated
public static RubyArray<T extends IRubyObject>	entries(IRubyObject recv, IRubyObject path, IRubyObject arg, IRubyObject opts) Deprecated
private static RubyArray<T extends IRubyObject>	entriesCommon(ThreadContext context, IRubyObject path, Encoding encoding, final boolean childrenOnly)
public static IRubyObject	exist(ThreadContext context, IRubyObject recv, IRubyObject arg)
public static IRubyObject	exists_p(ThreadContext context, IRubyObject recv, IRubyObject arg) Deprecated since 10.0.
public static IRubyObject	fchdir(ThreadContext context, IRubyObject dirClass, IRubyObject ignored)
public IRubyObject	fileno(ThreadContext context)
public static IRubyObject	for_fd(ThreadContext context, IRubyObject recv, IRubyObject ignored)
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`.
public static IRubyObject	foreach(ThreadContext context, IRubyObject recv, IRubyObject path, IRubyObject encOpts, Block block)
private static IRubyObject	foreachCommon(ThreadContext context, IRubyObject recv, RubyString path, IRubyObject encOpts, Block block)
protected static List<String>	getContents(FileResource directory) Deprecated since 9.4-. no longer used
protected static List<RubyString>	getContents(FileResource directory, Ruby runtime) Deprecated since 9.4-. no longer used
private static String	getCWD(Ruby runtime)
protected static FileResource	getDir(final Ruby runtime, final String path for which to return the `File` object. path, final boolean is true the directory must exist. If false it must not. mustExist) Returns a Java `File` object for the specified path.
protected static JRubyFile	getDirForRmdir(final Ruby runtime, final String path) Similar to getDir, but performs different checks to match rmdir behavior.
private static Encoding	getEncodingFromOpts(ThreadContext context, IRubyObject encOpts)
private static String[]	getEntries(ThreadContext context, FileResource dir, String path)
private static FileResource	getExistingDir(final Ruby runtime, final String path)
public static IRubyObject	getHomeDirectoryPath(ThreadContext context, String user) Returns the home directory of the specified `user` on the system.
public static RubyString	getHomeDirectoryPath(ThreadContext context)
pack-priv static RubyString	getHomeDirectoryPath(ThreadContext context, IRubyObject home)
public static Optional<String>	getHomeFromEnv(Ruby runtime)
public String	getPath()
public static RubyString	getwd(IRubyObject recv) Deprecated since 10.0.
public static RubyString	getwd(ThreadContext context, IRubyObject recv) Returns the current directory.
public static IRubyObject	glob(ThreadContext context, IRubyObject recv, IRubyObject[] args, Block block) Returns an array of filenames matching the specified wildcard pattern `pat`.
private static ByteList	globArgumentAsByteList(ThreadContext context, IRubyObject arg)
private static void	globOptions(ThreadContext context, IRubyObject[] args, String[] keys, RubyDir.GlobOptions options)
public static IRubyObject	home(ThreadContext context, IRubyObject recv) Returns the home directory of the current user or the named user if given.
public static IRubyObject	home(ThreadContext context, IRubyObject recv, IRubyObject user)
public static IRubyObject	home(ThreadContext context, IRubyObject recv, IRubyObject[] args) Deprecated
public IRubyObject	Returns: a new Dir object initialize(ThreadContext current context context, IRubyObject target path path) Creates a new `Dir`.
public IRubyObject	Returns: a new Dir object initialize(ThreadContext current context context, IRubyObject target path path, IRubyObject encoding options encOpts) Like `initialize(ThreadContext, IRubyObject)` but accepts an :encoding option.
private RubyDir	initializeCommon(ThreadContext context, IRubyObject pathArg, IRubyObject encOpts)
public IRubyObject	inspect(ThreadContext context) Overrides org.jruby.RubyBasicObject.inspect. Overrides default org.jruby.runtime.builtin.IRubyObject.inspect. Returns a string containing a human-readable representation of obj.
private static String[]	list(FileResource directory)
public static IRubyObject	mkdir(ThreadContext context, IRubyObject recv, IRubyObject... args) Creates the directory specified by `path`.
public static IRubyObject	mkdir(IRubyObject recv, IRubyObject[] args) Deprecated
private static IRubyObject	mkdirCommon(ThreadContext context, String path, IRubyObject[] args)
private static RubyArray<T extends IRubyObject>	newEntryArray(ThreadContext context, String[] files, Encoding encoding, boolean childrenOnly)
private static RubyString	newFilesystemString(ThreadContext context, String home)
public static IRubyObject	open(ThreadContext context, IRubyObject recv, IRubyObject path, Block block) Returns a new directory object for `path`.
public static IRubyObject	open(ThreadContext context, IRubyObject recv, IRubyObject path, IRubyObject encOpts, Block block)
public IRubyObject	path(ThreadContext context)
public IRubyObject	rb_each_child(ThreadContext context, Block block)
public IRubyObject	read() Deprecated since 10.0.
public IRubyObject	read(ThreadContext context) Returns the next entry from this directory.
public IRubyObject	rewind() Deprecated since 10.0.
public IRubyObject	rewind(ThreadContext context) Moves position in this directory to the first entry.
public static IRubyObject	rmdir(IRubyObject recv, IRubyObject path) Deprecated since 10.0.
public static IRubyObject	rmdir(ThreadContext context, IRubyObject recv, IRubyObject path) Deletes the directory specified by `path`.
public static IRubyObject	rmdir19(IRubyObject recv, IRubyObject path) Deprecated
private static RubyFixnum	rmdirCommon(ThreadContext context, String path)
public IRubyObject	seek(IRubyObject newPos) Deprecated since 10.0.
public IRubyObject	seek(ThreadContext context, IRubyObject newPos) Moves to a position `d`.
public IRubyObject	set_pos(IRubyObject newPos) Deprecated since 10.0.
public IRubyObject	set_pos(ThreadContext context, IRubyObject newPos)
public RubyInteger	tell(ThreadContext context) Returns the current position in the directory.
public RubyInteger	tell() Deprecated
public IRubyObject	to_path(ThreadContext context)
public <T> T	toJava(Class<T> The target type to which the object should be converted. target) Overrides org.jruby.RubyBasicObject.toJava. Implements org.jruby.runtime.builtin.IRubyObject.toJava. Convert the object to the specified Java class, if possible.

public Class RubyDir

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary