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

Modifier and Type	Field and Description
private final ClassLoader	cl
public static final String	CLASSLOADER
private final String[]	list
private final String	pathname
public static final String	URI
private final String	uri
public static final String	URI_CLASSLOADER
private final URL	url

Access	Constructor and Description
pack-priv	URLResource(String uri, URL url, String[] files)
pack-priv	URLResource(String uri, ClassLoader cl, String pathname, String[] files)
private	URLResource(String uri, URL url, ClassLoader cl, String pathname, String[] files)

Modifier and Type	Method and Description
public String	absolutePath() Implements org.jruby.util.FileResource.absolutePath.
private static boolean	addDirectoriesFromClassloader(ClassLoader cl, Set<String> list, String pathname, boolean isDirectory)
private static boolean	addDirectoryEntries(Set<String> entries, URL url, boolean isDirectory)
public boolean	canExecute() Implements org.jruby.util.FileResource.canExecute.
public String	canonicalPath() Implements org.jruby.util.FileResource.canonicalPath.
public boolean	canRead() Implements org.jruby.util.FileResource.canRead.
public boolean	canWrite() Implements org.jruby.util.FileResource.canWrite.
private static void	close(final Closeable resource)
public static FileResource	create(Ruby runtime, String pathname, boolean asFile)
public static FileResource	createClassloaderURI(Ruby runtime, String pathname, boolean asFile)
private static FileResource	createRegularURI(String pathname, boolean asFile)
public FileTime	creationTime() Implements org.jruby.util.DummyResourceStat.FileResourceExt.creationTime.
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	errno() Implements org.jruby.util.FileResource.errno.
public boolean	exists() Implements org.jruby.util.FileResource.exists.
public static URL	getResourceURL(Ruby runtime, String location)
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	isDirectory() Implements org.jruby.util.FileResource.isDirectory.
public boolean	isFile() Implements org.jruby.util.FileResource.isFile.
public boolean	isSymLink() Implements org.jruby.util.FileResource.isSymLink.
public FileTime	lastAccessTime() Implements org.jruby.util.DummyResourceStat.FileResourceExt.lastAccessTime.
public long	lastModified() Implements org.jruby.util.FileResource.lastModified.
public FileTime	lastModifiedTime() Implements org.jruby.util.DummyResourceStat.FileResourceExt.lastModifiedTime.
public long	length() Implements org.jruby.util.FileResource.length.
public String[]	list() Implements org.jruby.util.FileResource.list.
private static String[]	listClassLoaderFiles(ClassLoader classloader, String pathname)
private static String[]	listFiles(String pathname)
private static String[]	listFilesFromInputStream(InputStream is)
public FileStat	lstat() Implements org.jruby.util.FileResource.lstat.
public Channel	openChannel(int flags, int perm) Implements org.jruby.util.FileResource.openChannel.
public InputStream	openInputStream() Implements org.jruby.util.FileResource.openInputStream. Opens a new input stream to read the contents of a resource and returns it.
public String	path() Implements org.jruby.util.FileResource.path.
public FileStat	stat() Implements org.jruby.util.FileResource.stat.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public <T> T	unwrap(Class<T> type) Implements org.jruby.util.FileResource.unwrap. Unwrap the resource backend (replacement for `hackyGetJRubyFile()`).

cl	back to summary
private final ClassLoader cl

CLASSLOADER	back to summary
public static final String CLASSLOADER

list	back to summary
private final String[] list

pathname	back to summary
private final String pathname

URI	back to summary
public static final String URI

uri	back to summary
private final String uri

URI_CLASSLOADER	back to summary
public static final String URI_CLASSLOADER

url	back to summary
private final URL url

URLResource	back to summary
pack-priv URLResource(String uri, URL url, String[] files)

URLResource	back to summary
pack-priv URLResource(String uri, ClassLoader cl, String pathname, String[] files)

URLResource	back to summary
private URLResource(String uri, URL url, ClassLoader cl, String pathname, String[] files)

Method Detail

absolutePath	back to summary
public String absolutePath() Implements org.jruby.util.FileResource.absolutePath. Annotations @Override

absolutePath

public String absolutePath()

Implements org.jruby.util.FileResource.absolutePath.

Annotations

@Override

addDirectoriesFromClassloader	back to summary
private static boolean addDirectoriesFromClassloader(ClassLoader cl, Set<String> list, String pathname, boolean isDirectory) throws IOException

addDirectoryEntries	back to summary
private static boolean addDirectoryEntries(Set<String> entries, URL url, boolean isDirectory)

canExecute	back to summary
public boolean canExecute() Implements org.jruby.util.FileResource.canExecute. Annotations @Override

canExecute

back to summary

public boolean canExecute()

Implements org.jruby.util.FileResource.canExecute.

Annotations

@Override

canonicalPath	back to summary
public String canonicalPath() Implements org.jruby.util.FileResource.canonicalPath. Annotations @Override

canonicalPath

back to summary

public String canonicalPath()

Implements org.jruby.util.FileResource.canonicalPath.

Annotations

@Override

canRead	back to summary
public boolean canRead() Implements org.jruby.util.FileResource.canRead. Annotations @Override

canRead

back to summary

public boolean canRead()

Implements org.jruby.util.FileResource.canRead.

Annotations

@Override

canWrite	back to summary
public boolean canWrite() Implements org.jruby.util.FileResource.canWrite. Annotations @Override

canWrite

back to summary

public boolean canWrite()

Implements org.jruby.util.FileResource.canWrite.

Annotations

@Override

close	back to summary
private static void close(final Closeable resource)

create	back to summary
public static FileResource create(Ruby runtime, String pathname, boolean asFile)

createClassloaderURI	back to summary
public static FileResource createClassloaderURI(Ruby runtime, String pathname, boolean asFile)

createRegularURI	back to summary
private static FileResource createRegularURI(String pathname, boolean asFile)

creationTime	back to summary
public FileTime creationTime() Implements org.jruby.util.DummyResourceStat.FileResourceExt.creationTime.

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

errno	back to summary
public int errno() Implements org.jruby.util.FileResource.errno. Annotations @Override

errno

back to summary

public int errno()

Implements org.jruby.util.FileResource.errno.

Annotations

@Override

exists	back to summary
public boolean exists() Implements org.jruby.util.FileResource.exists. Annotations @Override

exists

back to summary

public boolean exists()

Implements org.jruby.util.FileResource.exists.

Annotations

@Override

getResourceURL	back to summary
public static URL getResourceURL(Ruby runtime, String location)

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

isDirectory	back to summary
public boolean isDirectory() Implements org.jruby.util.FileResource.isDirectory. Annotations @Override

isDirectory

back to summary

public boolean isDirectory()

Implements org.jruby.util.FileResource.isDirectory.

Annotations

@Override

isFile	back to summary
public boolean isFile() Implements org.jruby.util.FileResource.isFile. Annotations @Override

isFile

back to summary

public boolean isFile()

Implements org.jruby.util.FileResource.isFile.

Annotations

@Override

isSymLink	back to summary
public boolean isSymLink() Implements org.jruby.util.FileResource.isSymLink. Annotations @Override

isSymLink

back to summary

public boolean isSymLink()

Implements org.jruby.util.FileResource.isSymLink.

Annotations

@Override

lastAccessTime	back to summary
public FileTime lastAccessTime() Implements org.jruby.util.DummyResourceStat.FileResourceExt.lastAccessTime.

lastModified	back to summary
public long lastModified() Implements org.jruby.util.FileResource.lastModified. Annotations @Override

lastModified

back to summary

public long lastModified()

Implements org.jruby.util.FileResource.lastModified.

Annotations

@Override

lastModifiedTime	back to summary
public FileTime lastModifiedTime() Implements org.jruby.util.DummyResourceStat.FileResourceExt.lastModifiedTime.

length	back to summary
public long length() Implements org.jruby.util.FileResource.length. Annotations @Override

length

back to summary

public long length()

Implements org.jruby.util.FileResource.length.

Annotations

@Override

list	back to summary
public String[] list() Implements org.jruby.util.FileResource.list. Annotations @Override

list

back to summary

public String[] list()

Implements org.jruby.util.FileResource.list.

Annotations

@Override

listClassLoaderFiles	back to summary
private static String[] listClassLoaderFiles(ClassLoader classloader, String pathname)

listFiles	back to summary
private static String[] listFiles(String pathname)

listFilesFromInputStream	back to summary
private static String[] listFilesFromInputStream(InputStream is)

lstat	back to summary
public FileStat lstat() Implements org.jruby.util.FileResource.lstat. Annotations @Override

lstat

back to summary

public FileStat lstat()

Implements org.jruby.util.FileResource.lstat.

Annotations

@Override

openChannel	back to summary
public Channel openChannel(int flags, int perm) throws IOException Implements org.jruby.util.FileResource.openChannel. Annotations @Override

openChannel

back to summary

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

Implements org.jruby.util.FileResource.openChannel.

Annotations

@Override

openInputStream	back to summary
public InputStream openInputStream() throws IOException Implements org.jruby.util.FileResource.openInputStream. Doc from org.jruby.util.FileResource.openInputStream. 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 Annotations @Override

openInputStream

back to summary

public InputStream openInputStream() throws IOException

Implements org.jruby.util.FileResource.openInputStream.

Doc from org.jruby.util.FileResource.openInputStream.

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

Annotations

@Override

path	back to summary
public String path() Implements org.jruby.util.FileResource.path. Annotations @Override

path

back to summary

public String path()

Implements org.jruby.util.FileResource.path.

Annotations

@Override

stat	back to summary
public FileStat stat() Implements org.jruby.util.FileResource.stat. Annotations @Override

stat

back to summary

public FileStat stat()

Implements org.jruby.util.FileResource.stat.

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

unwrap back to summary

unwrap	back to summary
public <T> T unwrap(Class<T> type) throws UnsupportedOperationException Implements org.jruby.util.FileResource.unwrap. Doc from org.jruby.util.FileResource.unwrap. Unwrap the resource backend (replacement for `hackyGetJRubyFile()`). Returns:T backend if supported Annotations @Override

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

Implements org.jruby.util.FileResource.unwrap.

Doc from org.jruby.util.FileResource.unwrap.

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

Returns:T

backend if supported

Annotations

@Override

public Class URLResource

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail