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

Modifier and Type	Field and Description
pack-priv static final ByteList	BACKSLASH
private static final byte[]	CLOSED_MESSAGE
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
public static final int	LOCK_EX
public static final int	LOCK_NB
public static final int	LOCK_SH
public static final int	LOCK_UN
private static final int	NULL_CHAR
protected String	path Deprecated
pack-priv static final Pattern	PROTOCOL_PATTERN
private static final Pattern	PROTOCOL_PREFIX_PATTERN
private static final Pattern	ROOT_PATTERN
private static final long	serialVersionUID
pack-priv static final ByteList	SLASH
private static final String[]	SLASHES
private static final Pattern	URI_PREFIX
private static final String	URI_PREFIX_STRING

Access	Constructor and Description
public	RubyFile(Ruby runtime, RubyClass type)
pack-priv	RubyFile(Ruby runtime, String path, final Reader reader)
public	RubyFile(Ruby runtime, String path, InputStream in)
public	RubyFile(Ruby runtime, String path, FileChannel channel)

Method Summary

Modifier and Type	Method and Description
public static IRubyObject	absolute_path(ThreadContext context, IRubyObject recv, IRubyObject path) Converts a pathname to an absolute pathname.
public static IRubyObject	absolute_path(ThreadContext context, IRubyObject recv, IRubyObject path, IRubyObject dir) Converts a pathname to an absolute pathname.
public static IRubyObject	absolute_path(ThreadContext context, IRubyObject recv, IRubyObject[] args) Deprecated
public static IRubyObject	absolute_path_p(ThreadContext context, IRubyObject recv, IRubyObject arg)
private static String	adjustPostFixDotDot(String postFix)
pack-priv static String	adjustRootPathOnWindows(Ruby runtime, String path, String dir)
private static StringBuilder	appendSlash(final CharSequence canonicalPath)
public IRubyObject	atime(ThreadContext context)
public static IRubyObject	atime(ThreadContext context, IRubyObject recv, IRubyObject filename)
public static RubyString	basename(ThreadContext context, IRubyObject recv, IRubyObject path)
public static RubyString	basename(ThreadContext context, IRubyObject recv, IRubyObject path, IRubyObject ext)
public static IRubyObject	basename(ThreadContext context, IRubyObject recv, IRubyObject[] args) Deprecated
private static RubyString	basenameImpl(ThreadContext context, RubyClass klass, IRubyObject path, IRubyObject ext)
public IRubyObject	birthtime(ThreadContext context)
public static IRubyObject	birthtime(ThreadContext context, IRubyObject recv, IRubyObject filename)
public static String	canonicalize(String path)
private static CharSequence	canonicalize(CharSequence canonicalPath, String remaining)
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
public IRubyObject	chmod(ThreadContext context, IRubyObject arg)
public static IRubyObject	chmod(ThreadContext context, IRubyObject recv, IRubyObject[] args)
private static int	chomp(final StringBuilder buffer)
public IRubyObject	chown(ThreadContext context, IRubyObject arg1, IRubyObject arg2)
public 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.
public static RubyClass	createFileClass(ThreadContext context, RubyClass IO)
public IRubyObject	ctime(ThreadContext context)
public static IRubyObject	ctime(ThreadContext context, IRubyObject recv, IRubyObject filename)
public static IRubyObject	delete(ThreadContext context, IRubyObject recv, IRubyObject[] args)
private static boolean	dir_fnmatch(ByteList pattern, ByteList path, int flags)
public static IRubyObject	dirname(ThreadContext context, IRubyObject recv, IRubyObject path)
public static IRubyObject	dirname(ThreadContext context, IRubyObject recv, IRubyObject path, IRubyObject arg1)
public static String	dirname(ThreadContext context, final String filename)
public static String	dirname(ThreadContext context, final String filename, int level)
public static IRubyObject	dirname(ThreadContext context, IRubyObject recv, IRubyObject[] args) Deprecated
private static RubyString	dirnameCommon(ThreadContext context, RubyString filename, int level)
private static RubyString	doJoin(ThreadContext context, IRubyObject recv, IRubyObject[] args)
public static IRubyObject	Returns: Resulting absolute path as a String expand_path(ThreadContext context, IRubyObject recv, IRubyObject path) Converts a pathname to an absolute pathname.
public static IRubyObject	Returns: Resulting absolute path as a String expand_path(ThreadContext context, IRubyObject recv, IRubyObject path, IRubyObject wd) Converts a pathname to an absolute pathname.
public static IRubyObject	expand_path(ThreadContext context, IRubyObject recv, IRubyObject... args) Deprecated
public static String	expandPath(ThreadContext context, String relativePath, Encoding[] enc, String cwd, boolean expandUser, boolean canonicalize)
private static RubyString	expandPathInternal(ThreadContext context, IRubyObject arg0, boolean expandUser, boolean canonicalize)
private static RubyString	expandPathInternal(ThreadContext context, IRubyObject _path, IRubyObject _wd, boolean expandUser, boolean canonicalize)
pack-priv 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) Deprecated
public static String	Returns: Expanded path expandUserPath(ThreadContext context, String Path to check 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.
public static String	expandUserPath(ThreadContext context, String path, final boolean raiseOnRelativePath)
public static IRubyObject	Returns: Extension, including the dot, or an empty string extname(ThreadContext context, IRubyObject recv, IRubyObject Path to get extension name of 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.
public static JRubyFile	file(IRubyObject pathOrFile) Deprecated
public IRubyObject	fileOpenGeneric(ThreadContext context, IRubyObject filename, int oflags, int fmode, IOEncodable convConfig, int perm)
protected static RubyString	filePathConvert(ThreadContext context, RubyString path)
public static FileResource	fileResource(ThreadContext current thread context context, IRubyObject the string or IO to use for the path pathOrFile) Get the fully-qualified JRubyFile object for the path, taking into account the runtime's current directory.
public static FileResource	fileResource(IRubyObject the string or IO to use for the path pathOrFile) Deprecated since 9.4-. Get the fully-qualified JRubyFile object for the path, taking into account the runtime's current directory.
public IRubyObject	flock(ThreadContext context, IRubyObject operation)
public static IRubyObject	fnmatch(ThreadContext context, IRubyObject recv, IRubyObject _pattern, IRubyObject _path) Returns true if path matches against pattern The pattern is not a regular expression; instead it follows rules similar to shell filename globbing.
public static IRubyObject	fnmatch(ThreadContext context, IRubyObject recv, IRubyObject _pattern, IRubyObject _path, IRubyObject _flags)
public static IRubyObject	fnmatch(ThreadContext context, IRubyObject recv, IRubyObject[] args) Deprecated
private static RubyBoolean	fnmatchCommon(ThreadContext context, IRubyObject _path, IRubyObject _pattern, int flags)
public static IRubyObject	ftype(ThreadContext context, IRubyObject recv, IRubyObject filename)
public static RubyString	get_path(ThreadContext context, IRubyObject path)
public static String	getAdjustedPath(ThreadContext context, IRubyObject fileOrPath)
public static String	getAdjustedPath(ThreadContext context, IRubyObject fileOrPath, String currentDirectory)
private static int	getAltSeparatorChar(ThreadContext context, final RubyClass File)
public static final FileTime	getBirthtimeWithNIO(String pathString)
private static String	getDecodedPath(ThreadContext context, IRubyObject pathOrFile)
public static ZipEntry	getDirOrFileEntry(String jar, String path) Deprecated
public static ZipEntry	getDirOrFileEntry(ZipFile jar, String path) Deprecated
public Encoding	getEncoding() Implements org.jruby.runtime.encoding.EncodingCapable.getEncoding.
private static ZipEntry	getFileEntry(ZipFile jar, String path, final String prefixForNoEntry)
private static String	getNullDevice()
private static int	getSeparatorChar(ThreadContext context, final RubyClass File)
pack-priv final long	getSize(ThreadContext context)
public IRubyObject	initialize(ThreadContext context, IRubyObject[] args, Block block)
public RubyString	inspect(ThreadContext context) Overrides org.jruby.RubyIO.inspect. Overrides default org.jruby.runtime.builtin.IRubyObject.inspect. Returns a string containing a human-readable representation of obj.
private static boolean	isAbsolutePath(String path)
private static boolean	isDirSeparator(char c)
private static boolean	isJRubyAbsolutePath(String path)
private static boolean	isLocalURI(String canonicalPathString)
private static boolean	isSymlink(ThreadContext context, JRubyFile file)
private static boolean	isWindowsDriveLetter(char c)
public static RubyString	join(ThreadContext context, IRubyObject recv, IRubyObject[] args)
private static boolean	joinImpl(final StringBuilder buffer, final String separator, ThreadContext context, IRubyObject recv, RubyArray<T extends IRubyObject> args)
private static StringBuilder	joinImplInspecting(final String separator, ThreadContext context, IRubyObject recv, RubyArray<T extends IRubyObject> parent, RubyArray<T extends IRubyObject> array)
public static IRubyObject	lchmod(ThreadContext context, IRubyObject recv, IRubyObject[] args)
public static IRubyObject	lchown(ThreadContext context, IRubyObject recv, IRubyObject[] args)
public static IRubyObject	link(ThreadContext context, IRubyObject recv, IRubyObject from, IRubyObject to)
public IRubyObject	lstat(ThreadContext context)
public static IRubyObject	lstat(ThreadContext context, IRubyObject recv, IRubyObject filename)
public static IRubyObject	lutime(ThreadContext context, IRubyObject recv, IRubyObject[] args)
public static IRubyObject	mkfifo(ThreadContext context, IRubyObject recv, IRubyObject path)
public static IRubyObject	mkfifo(ThreadContext context, IRubyObject recv, IRubyObject path, IRubyObject mode)
public static IRubyObject	mkfifo(ThreadContext context, RubyString path, int mode)
public IRubyObject	mtime(ThreadContext context)
public static IRubyObject	mtime(ThreadContext context, IRubyObject recv, IRubyObject filename)
protected IRubyObject	openFile(ThreadContext context, IRubyObject[] args)
public static IRubyObject	path(ThreadContext context, IRubyObject self, IRubyObject str)
public IRubyObject	path(ThreadContext context) Overrides org.jruby.RubyIO.path.
protected IRubyObject	rbIoClose(ThreadContext context) Overrides org.jruby.RubyIO.rbIoClose.
public static IRubyObject	readlink(ThreadContext context, IRubyObject recv, IRubyObject path)
public static IRubyObject	realdirpath(ThreadContext context, IRubyObject recv, IRubyObject path)
public static IRubyObject	realdirpath(ThreadContext context, IRubyObject recv, IRubyObject path, IRubyObject dir)
public static IRubyObject	realdirpath(ThreadContext context, IRubyObject recv, IRubyObject[] args) Deprecated
public static IRubyObject	realpath(ThreadContext context, IRubyObject recv, IRubyObject path)
public static IRubyObject	realpath(ThreadContext context, IRubyObject recv, IRubyObject path, IRubyObject cwd)
public static IRubyObject	realpath(ThreadContext context, IRubyObject recv, IRubyObject[] args) Deprecated
private static RubyString	realPathCommon(ThreadContext context, RubyString file, RubyString cwd)
public static IRubyObject	rename(ThreadContext context, IRubyObject recv, IRubyObject oldName, IRubyObject newName)
private static String	replace(final String str, CharSequence target, CharSequence replace)
public void	setEncoding(Encoding encoding) Implements org.jruby.runtime.encoding.EncodingCapable.setEncoding.
private static JavaSites.FileSites	sites(ThreadContext context) Hides org.jruby.RubyIO.sites. Retrieve the call sites for this class.
public IRubyObject	size(ThreadContext context)
public static RubyArray<T extends IRubyObject>	split(ThreadContext context, IRubyObject recv, IRubyObject arg)
public static String[]	splitURI(String path)
public static boolean	startsWithDriveLetterOnWindows(String path)
pack-priv static boolean	startsWithDriveLetterOnWindows(CharSequence path)
public static IRubyObject	stat(ThreadContext context, IRubyObject recv, IRubyObject filename)
public static IRubyObject	symlink(ThreadContext context, IRubyObject recv, IRubyObject from, IRubyObject to)
public <T> T	toJava(Class<T> The target type to which the object should be converted. target) Overrides org.jruby.RubyIO.toJava. Implements org.jruby.runtime.builtin.IRubyObject.toJava. Convert the object to the specified Java class, if possible.
public String	toString() Overrides org.jruby.RubyIO.toString. The default toString method is just a wrapper that calls the Ruby "to_s" method.
public IRubyObject	truncate(ThreadContext context, IRubyObject len)
public static IRubyObject	truncate(ThreadContext context, IRubyObject recv, IRubyObject path, IRubyObject length)
public static IRubyObject	truncate19(ThreadContext context, IRubyObject recv, IRubyObject path, IRubyObject length) Deprecated
private static IRubyObject	truncateCommon(ThreadContext context, IRubyObject recv, IRubyObject arg1, IRubyObject arg2)
public static IRubyObject	umask(ThreadContext context, IRubyObject recv, IRubyObject[] args)
public static IRubyObject	unlink(ThreadContext context, IRubyObject recv, IRubyObject[] args)
public static IRubyObject	unlink(ThreadContext context, IRubyObject... args)
public static IRubyObject	utime(ThreadContext context, IRubyObject recv, IRubyObject[] args)

Inherited from org.jruby.RubyIO:: addBlockingThread adviceArgCheck advise autoclose autoclose_set binmode binmode binread binwrite bytes chars 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 copy_stream copy_stream createIOClass doRead doReadNonblock doReadNonblock doReadNonblock doReadNonblock doWriteNonblock each each each each each each_byte each_byteInternal each_char each_charInternal each_codepoint each_line each_line each_line each_line each_line ensureYieldClose ensureYieldClosePipes eof_p external_encoding failIfDirectory fcntl fcntl fileno flush flush flushRaw for_fd foreach fsync getBlocking getBOM getbyte getByte getc getc getChannel getEcflags getEcopts getEnc getEnc2 getInputEncoding getInStream getIOModes getIOModesIntFromString getline getline getline getline getline getline getlineImpl getNativeClassIndex getOpenFile getOpenFileChecked getOpenFileInitialized getOutStream getPartial getPartial getPartial getPartial getPartial getPath 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 MakeOpenFile newInstance newIO newIOOptions newIOOptions newIOOptions newIOOptions newIOOptions newModeFlags newModeFlags newModeFlags nonblockEOF obliterateProcess op_append op_binmode open parseIOOptions pid pipe pipe pipe pipe pipe pipe popen popen3 popen4 popenSpecial pos pos_set pread pread prepStdio prepStdio print print print print print print print0 print1 print2 print3 printf printf putc putc puts puts puts puts puts puts puts0 puts1 puts2 puts3 pwrite read read read read read read read read read_nonblock read_nonblock read_nonblock read_nonblock readbyte readchar readchar readline readline readline readline readline readlines readlines readlines readlines readlines readlines readpartial readpartial readpartial removeBlockingThread reopen reopenIO rewind seek seek seek seekBeforeAccess select select_static set_encoding set_encoding set_encoding set_encoding_by_bom setAscii8bitBinmode setAutoclose setBlocking setBOM setEcflags setEcopts setEnc setEnc2 setEncoding setPath setSync stat sync sync_set sync_set sysopen sysopen sysopen sysread sysread sysread sysseek syswrite to_io tryConvert tty_p ungetbyte ungetc updateIOOptionsFromOptions wait wait wait_readable wait_readable wait_writable wait_writable write write write write write write write write write write write write write write write write write2 write3 write_nonblock write_nonblock write_nonblock writeStatic writev writev writev writev writev

public Class RubyFile

Field Summary

Constructor Summary

Method Summary