JRuby Base 9.4.8.0 · org.jruby.util.FileResource · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public String	absolutePath()
public boolean	canExecute()
public String	canonicalPath()
public boolean	canRead()
public boolean	canWrite()
public int	errno()
public boolean	exists()
public default JRubyFile	hackyGetJRubyFile() Deprecated
public default InputStream	Returns: just opened InputStream inputStream() Deprecated Opens a new input stream to read the contents of a resource and returns it.
public boolean	isDirectory()
public boolean	isFile()
public default boolean	Returns: is this a NUL device? isNull()
public boolean	isSymLink()
public long	lastModified()
public long	length()
public String[]	list()
public FileStat	lstat()
public default Channel	Returns: channel openChannel(ModeFlags flags, int perm) Deprecated use `openChannel(int, int)` instead
public Channel	openChannel(int flags, int perm)
public InputStream	Returns: InputStream openInputStream() Opens a new input stream to read the contents of a resource and returns it.
public String	path()
public FileStat	stat()
public <T> T	Returns: backend if supported unwrap(Class<T> type) Unwrap the resource backend (replacement for `hackyGetJRubyFile()`).
public static FileResource	wrap(POSIX posix, JRubyFile file)

Method Detail

absolutePath	back to summary
public String absolutePath()

canExecute	back to summary
public boolean canExecute()

canonicalPath	back to summary
public String canonicalPath()

canRead	back to summary
public boolean canRead()

canWrite	back to summary
public boolean canWrite()

errno	back to summary
public int errno()

exists	back to summary
public boolean exists()

hackyGetJRubyFile	back to summary
public default JRubyFile hackyGetJRubyFile() Deprecated Annotations @Deprecated

inputStream	back to summary
public default 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:InputStream just opened InputStream Exceptions ResourceException: is the file does not exists or if the resource is a directory

inputStream

back to summary

public default 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:InputStream

just opened InputStream

Exceptions

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

isDirectory	back to summary
public boolean isDirectory()

isFile	back to summary
public boolean isFile()

isNull	back to summary
public default boolean isNull() Returns:boolean is this a NUL device?

isSymLink	back to summary
public boolean isSymLink()

lastModified	back to summary
public long lastModified()

length	back to summary
public long length()

list	back to summary
public String[] list() See Also `java.io.File#list()`

lstat	back to summary
public FileStat lstat()

openChannel	back to summary
public default Channel openChannel(ModeFlags flags, int perm) throws ResourceException Deprecated use `openChannel(int, int)` instead Returns:Channel channel

openChannel	back to summary
public Channel openChannel(int flags, int perm) throws IOException

openInputStream	back to summary
public InputStream openInputStream() throws 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 InputStream

openInputStream

back to summary

public InputStream openInputStream() throws IOException

Returns:InputStream: InputStream

path	back to summary
public String path()

stat	back to summary
public FileStat stat()

unwrap back to summary

unwrap	back to summary
public <T> T unwrap(Class<T> type) throws UnsupportedOperationException Unwrap the resource backend (replacement for `hackyGetJRubyFile()`). Returns:T backend if supported

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

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

Returns:T: backend if supported

wrap	back to summary
public static FileResource wrap(POSIX posix, JRubyFile file)

public Interface FileResource

Method Summary

Method Detail