Package org.jruby.util

Class RegularFileResource

java.lang.Object

org.jruby.util.RegularFileResource

All Implemented Interfaces:

FileResource

class RegularFileResource
extends Object
implements FileResource

Represents a "regular" file, backed by regular file system.

Field Summary

Fields

Modifier and Type	Field	Description
private final JRubyFile	file
private BasicFileAttributes	fileAttributes
private final String	filePath
private final jnr.posix.POSIX	posix

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RegularFileResource(jnr.posix.POSIX posix, String filename)
(package private)	RegularFileResource(jnr.posix.POSIX posix, JRubyFile file, String filePath)

Method Summary

Modifier and Type	Method	Description
String	absolutePath()
boolean	canExecute()
String	canonicalPath()
boolean	canRead()
boolean	canWrite()
private Channel	createChannel(ModeFlags flags)
FileTime	creationTime()
int	errno()
boolean	exists()
boolean	isDirectory()
boolean	isFile()
boolean	isSymLink()
FileTime	lastAccessTime()
long	lastModified()
FileTime	lastModifiedTime()
long	length()
String[]	list()
jnr.posix.FileStat	lstat()
(package private) static IOException	mapFileNotFoundOnGetChannel(FileResource file, FileNotFoundException ex)
Channel	openChannel(int flags, int perm)
InputStream	openInputStream()	Opens a new input stream to read the contents of a resource and returns it.
String	path()
private BasicFileAttributes	readAttributes()
jnr.posix.FileStat	stat()
private void	throwFromErrno(int err)
String	toString()
<T> T	unwrap(Class<T> type)	Unwrap the resource backend (replacement for FileResource.hackyGetJRubyFile()).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jruby.util.FileResource

hackyGetJRubyFile, inputStream, isNull, openChannel

Field Details

file

private final JRubyFile file

filePath

private final String filePath

posix

private final jnr.posix.POSIX posix

fileAttributes

private transient BasicFileAttributes fileAttributes

Constructor Details

RegularFileResource

RegularFileResource(jnr.posix.POSIX posix,
 JRubyFile file,
 String filePath)

RegularFileResource

protected RegularFileResource(jnr.posix.POSIX posix,
 String filename)

Method Details

absolutePath

public String absolutePath()

Specified by:

absolutePath in interface FileResource

canonicalPath

public String canonicalPath()

Specified by:

canonicalPath in interface FileResource

path

public String path()

Specified by:

path in interface FileResource

length

public long length()

Specified by:

length in interface FileResource

lastModified

public long lastModified()

Specified by:

lastModified in interface FileResource

lastModifiedTime

public FileTime lastModifiedTime()
                          throws IOException

Throws:

IOException

lastAccessTime

public FileTime lastAccessTime()
                        throws IOException

Throws:

IOException

creationTime

public FileTime creationTime()
                      throws IOException

Throws:

IOException

readAttributes

private BasicFileAttributes readAttributes()
                                    throws IOException

Throws:

IOException

exists

public boolean exists()

Specified by:

exists in interface FileResource

canExecute

public boolean canExecute()

Specified by:

canExecute in interface FileResource

errno

public int errno()

Specified by:

errno in interface FileResource

isFile

public boolean isFile()

Specified by:

isFile in interface FileResource

isDirectory

public boolean isDirectory()

Specified by:

isDirectory in interface FileResource

isSymLink

public boolean isSymLink()

Specified by:

isSymLink in interface FileResource

canRead

public boolean canRead()

Specified by:

canRead in interface FileResource

canWrite

public boolean canWrite()

Specified by:

canWrite in interface FileResource

list

public String[] list()

Specified by:

list in interface FileResource

See Also:

• File.list()

stat

public jnr.posix.FileStat stat()

Specified by:

stat in interface FileResource

lstat

public jnr.posix.FileStat lstat()

Specified by:

lstat in interface FileResource

toString

public String toString()

Overrides:

toString in class Object

openInputStream

public InputStream openInputStream()
                            throws IOException

Description copied from interface: FileResource

Opens a new input stream to read the contents of a resource and returns it. Note that implementations may be allocating native memory for the stream, so callers need to close this when they are done with it. users of this method should follow the pattern: close the stream where you open it.

Specified by:

openInputStream in interface FileResource

Returns:

InputStream

Throws:

IOException

openChannel

public Channel openChannel(int flags,
 int perm)
                    throws IOException

Specified by:

openChannel in interface FileResource

Throws:

IOException

createChannel

private Channel createChannel(ModeFlags flags)
                       throws IOException

Throws:

IOException

unwrap

public <T> T unwrap(Class<T> type)

Description copied from interface: FileResource

Unwrap the resource backend (replacement for FileResource.hackyGetJRubyFile()).

Specified by:

unwrap in interface FileResource

Returns:

backend if supported

mapFileNotFoundOnGetChannel

static IOException mapFileNotFoundOnGetChannel(FileResource file,
 FileNotFoundException ex)

throwFromErrno

private void throwFromErrno(int err)
                     throws IOException

Throws:

IOException