org.jruby.util

Interface FileResource

All Known Implementing Classes:

URLResource

public interface FileResource

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	absolutePath()
boolean	canExecute()
java.lang.String	canonicalPath()
boolean	canRead()
boolean	canWrite()
int	errno()
boolean	exists()
default JRubyFile	hackyGetJRubyFile() Deprecated.
default java.io.InputStream	inputStream() Deprecated. 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.
boolean	isDirectory()
boolean	isFile()
default boolean	isNull()
boolean	isSymLink()
long	lastModified()
long	length()
java.lang.String[]	list()
jnr.posix.FileStat	lstat()
java.nio.channels.Channel	openChannel(int flags, int perm)
default java.nio.channels.Channel	openChannel(ModeFlags flags, int perm) Deprecated. use openChannel(int, int) instead
java.io.InputStream	openInputStream() Opens a new input stream to read the contents of a resource and returns it.
jnr.posix.FileStat	stat()
<T> T	unwrap(java.lang.Class<T> type) Unwrap the resource backend (replacement for hackyGetJRubyFile()).
static FileResource	wrap(jnr.posix.POSIX posix, JRubyFile file)

Method Detail

wrap

static FileResource wrap(jnr.posix.POSIX posix,
                         JRubyFile file)

absolutePath

java.lang.String absolutePath()

canonicalPath

java.lang.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()

isNull

default boolean isNull()

Returns:

is this a NUL device?

list

java.lang.String[] list()

See Also:

File.list()

isSymLink

boolean isSymLink()

stat

jnr.posix.FileStat stat()

lstat

jnr.posix.FileStat lstat()

unwrap

<T> T unwrap(java.lang.Class<T> type)
      throws java.lang.UnsupportedOperationException

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

Type Parameters:

T -

Parameters:

type -

Returns:

backend if supported

Throws:

java.lang.UnsupportedOperationException

hackyGetJRubyFile

@Deprecated
default JRubyFile hackyGetJRubyFile()

Deprecated.

inputStream

default java.io.InputStream inputStream()
                                 throws ResourceException

Deprecated. 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

openInputStream

java.io.InputStream openInputStream()
                             throws java.io.IOException

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:

InputStream

Throws:

java.io.IOException

openChannel

default java.nio.channels.Channel openChannel(ModeFlags flags,
                                              int perm)
                                       throws ResourceException

Deprecated. use openChannel(int, int) instead

Parameters:

flags -

perm -

Returns:

channel

Throws:

ResourceException

openChannel

java.nio.channels.Channel openChannel(int flags,
                                      int perm)
                               throws java.io.IOException

Throws:

java.io.IOException