org.jruby.util

Interface FileResource

All Known Implementing Classes:

EmptyFileResource, URLResource

public interface FileResource

This is a shared interface for files loaded as File and ZipEntry.

Method Summary

Modifier and Type	Method and Description
String	absolutePath()
boolean	canExecute()
String	canonicalPath()
boolean	canRead()
boolean	canWrite()
int	errno()
boolean	exists()
JRubyFile	hackyGetJRubyFile()
InputStream	inputStream() Opens a new input stream to read the contents of a resource and returns it.
boolean	isDirectory()
boolean	isFile()
boolean	isSymLink()
long	lastModified()
long	length()
String[]	list()
jnr.posix.FileStat	lstat()
Channel	openChannel(ModeFlags flags, int perm)
jnr.posix.FileStat	stat()

Method Detail

absolutePath

String absolutePath()

canonicalPath

String canonicalPath()

exists

boolean exists()

isDirectory

boolean isDirectory()

isFile

boolean isFile()

canExecute

boolean canExecute()

errno

int errno()

lastModified

long lastModified()

length

long length()

canRead

boolean canRead()

canWrite

boolean canWrite()

list

String[] list()

See Also:

File.list()

isSymLink

boolean isSymLink()

stat

jnr.posix.FileStat stat()

lstat

jnr.posix.FileStat lstat()

hackyGetJRubyFile

JRubyFile hackyGetJRubyFile()

inputStream

InputStream inputStream()
                 throws ResourceException

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.

Returns:

just opened InputStream

Throws:

ResourceException - is the file does not exists or if the resource is a directory

openChannel

Channel openChannel(ModeFlags flags,
                    int perm)
             throws ResourceException

Throws:

ResourceException