Defines several factory methods for creating instances of Resource.
Note: It is very important to try an pass a method that creates/opens the underlying resource or the actual creation code as the opener. This is important so that the resource can be used more than once. If an opened resource is passed to the factory method the resulting resource can only be used once since it closes the resource when it is closed.
Example:
val URL = new URL("http://scala-lang.org")
val resource: Resource[InputStream] = Resource.fromInputStream(url.openStream).buffered
1.0
o != arg0 is the same as !(o == (arg0)).
o != arg0 is the same as !(o == (arg0)).
the object to compare against this object for dis-equality.
false if the receiver object is equivalent to the argument; true otherwise.
o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).
o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).
the object to compare against this object for equality.
true if the receiver object is equivalent to the argument; false otherwise.
o == arg0 is the same as o.equals(arg0).
o == arg0 is the same as o.equals(arg0).
the object to compare against this object for equality.
true if the receiver object is equivalent to the argument; false otherwise.
This method is used to cast the receiver object to be of type T0.
This method is used to cast the receiver object to be of type T0.
Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression
1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expression
List(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as
part of compilation it is not possible to check whether the contents of the list are of the requested typed.
the receiver object.
This method creates and returns a copy of the receiver object.
This method creates and returns a copy of the receiver object.
The default implementation of the clone method is platform dependent.
a copy of the receiver object.
This method is used to test whether the argument (arg0) is a reference to the
receiver object (this).
This method is used to test whether the argument (arg0) is a reference to the
receiver object (this).
The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on
non-null instances of AnyRef:
* It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true.
* It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and
only if y.eq(x) returns true.
* It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true
and y.eq(z) returns true, then x.eq(z) returns true.
Additionally, the eq method has three other properties.
* It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of
x.eq(y) consistently returns true or consistently returns false.
* For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false.
* null.eq(null) returns true.
When overriding the equals or hashCode methods, it is important to ensure that their behavior is
consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they
should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).
the object to compare against this object for reference equality.
true if the argument is a reference to the receiver object; false otherwise.
This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.
This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.
The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence
relation]:
* It is reflexive: for any instance x of type Any, x.equals(x) should return true.
* It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and
only if y.equals(x) returns true.
* It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and
y.equals(z) returns true, then x.equals(z) should return true.
If you override this method, you should verify that your implementation remains an equivalence relation.
Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects
that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int
(o1.hashCode.equals(o2.hashCode)).
the object to compare against this object for equality.
true if the receiver object is equivalent to the argument; false otherwise.
This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.
This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.
The details of when and if the finalize method are invoked, as well as the interaction between finalize
and non-local returns and exceptions, are all platform dependent.
Create an Input Resource instance from a BufferedInputStream
Create an Input Resource instance from a BufferedInputStream
The opener param is a by-name argument an is use to open a new stream. In other words it is important to try and pass in a function for opening the stream rather than the already opened stream so that the returned Resource can be used multiple time
the buffered method simply returns the same instance
the function for opening a new BufferedInputStream
An optional parameter for specifying an additional action to perform as the Resource is closed. This action will be executed just before close. Close actions can also be added to existing Resources
a InputStreamResource that is backed by a BufferedInputStream
Create an Output Resource instance from a BufferedOutputStream
Create an Output Resource instance from a BufferedOutputStream
The opener param is a by-name argument an is use to open a new stream. In other words it is important to try and pass in a function for opening the stream rather than the already opened stream so that the returned Resource can be used multiple time
the function for opening a new BufferedOutputStream
An optional parameter for specifying an additional action to perform as the Resource is closed. This action will be executed just before close. Close actions can also be added to existing Resources
a OutputStreamResource that is backed by a BufferedOutputStream
Create an ReadChars Resource instance from an BufferedReader.
Create an ReadChars Resource instance from an BufferedReader.
The opener param is a by-name argument an is use to open a new stream. In other words it is important to try and pass in a function for opening the stream rather than the already opened stream so that the returned Resource can be used multiple time
the function for opening a new BufferedReader
An optional parameter for specifying an additional action to perform as the Resource is closed. This action will be executed just before close. Close actions can also be added to existing Resources
a ReaderResource that is backed by a BufferedReader
Create an WriteChars Resource instance with conversion traits from an BufferedWriter.
Create an WriteChars Resource instance with conversion traits from an BufferedWriter.
The opener param is a by-name argument an is use to open a new stream. In other words it is important to try and pass in a function for opening the stream rather than the already opened stream so that the returned Resource can be used multiple time
the function for opening a new BufferedWriter
An optional parameter for specifying an additional action to perform as the Resource is closed. This action will be executed just before close. Close actions can also be added to existing Resources
a WriterResource that is backed by a BufferedWriter
Create an Input/Output Resource instance from a ByteChannel.
Create an Input/Output Resource instance from a ByteChannel.
The opener param is a by-name argument an is use to open a new stream. In other words it is important to try and pass in a function for opening the stream rather than the already opened stream so that the returned Resource can be used multiple time
the function for opening a new ByteChannel
An optional parameter for specifying an additional action to perform as the Resource is closed. This action will be executed just before close. Close actions can also be added to existing Resources
a ByteChannelResource
Create an InputStreamResource from a resource on the classpath.
Create an InputStreamResource from a resource on the classpath. The classloader from the provided class is used to resolve the resource.
An exception is thrown if the resource does not exist
Creates a Seekable Resource from a File
Creates a Seekable Resource from a File
the file to use for constructing a Seekable Resource
An optional parameter for specifying an additional action to perform as the Resource is closed. This action will be executed just before close. Close actions can also be added to existing Resources
a SeekableByteChannelResource
Create a file from string then create a Seekable Resource from a File
Create a file from string then create a Seekable Resource from a File
the file to use for constructing a Seekable Resource
An optional parameter for specifying an additional action to perform as the Resource is closed. This action will be executed just before close. Close actions can also be added to existing Resources
a SeekableByteChannelResource
Create an InputStreamResource from an InputStream or subclass
Create an InputStreamResource from an InputStream or subclass
The opener param is a by-name argument an is use to open a new stream. In other words it is important to try and pass in a function for opening the stream rather than the already opened stream so that the returned Resource can be used multiple time
the function for opening a new InputStream
An optional parameter for specifying an additional action to perform as the Resource is closed. This action will be executed just before close. Close actions can also be added to existing Resources
an InputStreamResource
Create an Output Resource instance from an OutputStream.
Create an Output Resource instance from an OutputStream.
The opener param is a by-name argument an is use to open a new stream. In other words it is important to try and pass in a function for opening the stream rather than the already opened stream so that the returned Resource can be used multiple time
the function for opening a new OutputStream
An optional parameter for specifying an additional action to perform as the Resource is closed. This action will be executed just before close. Close actions can also be added to existing Resources
an OutputStreamResource
Create an Input/Output/Seekable Resource instance from a RandomAccess file.
Create an Input/Output/Seekable Resource instance from a RandomAccess file.
The opener param is a by-name argument an is use to open a new stream. In other words it is important to try and pass in a function for opening the stream rather than the already opened stream so that the returned Resource can be used multiple time
the function for opening a new SeekableByteChannel
An optional parameter for specifying an additional action to perform as the Resource is closed. This action will be executed just before close. Close actions can also be added to existing Resources
a SeekableByteChannelResource
Create an Input Resource instance from an ReadableByteChannel.
Create an Input Resource instance from an ReadableByteChannel.
The opener param is a by-name argument an is use to open a new stream. In other words it is important to try and pass in a function for opening the stream rather than the already opened stream so that the returned Resource can be used multiple time
the function for opening a new ReadableByteChannel
An optional parameter for specifying an additional action to perform as the Resource is closed. This action will be executed just before close. Close actions can also be added to existing Resources
an ReadableByteChannelResource
Create an ReadChars Resource instance from an Reader.
Create an ReadChars Resource instance from an Reader.
The opener param is a by-name argument an is use to open a new stream. In other words it is important to try and pass in a function for opening the stream rather than the already opened stream so that the returned Resource can be used multiple time
the function for opening a new Reader
An optional parameter for specifying an additional action to perform as the Resource is closed. This action will be executed just before close. Close actions can also be added to existing Resources
an ReaderResource
Create an Input/Output/Seekable Resource instance from a SeekableByteChannel.
Create an Input/Output/Seekable Resource instance from a SeekableByteChannel.
The opener param is a by-name argument an is use to open a new stream. In other words it is important to try and pass in a function for opening the stream rather than the already opened stream so that the returned Resource can be used multiple time
the function for opening a new SeekableByteChannel
An optional parameter for specifying an additional action to perform as the Resource is closed. This action will be executed just before close. Close actions can also be added to existing Resources
a SeekableByteChannelResource
Creates an Input Resource from a URL
Creates an Input Resource from a URL
the url to use for constructing a InputStreamResource
An optional parameter for specifying an additional action to perform as the Resource is closed. This action will be executed just before close. Close actions can also be added to existing Resources
an InputStreamResource
Converts the string to a URL and creates an Input Resource from the URL
Converts the string to a URL and creates an Input Resource from the URL
the url string to use for constructing a InputStreamResource
An optional parameter for specifying an additional action to perform as the Resource is closed. This action will be executed just before close. Close actions can also be added to existing Resources
an InputStreamResource
Create an Output Resource instance from an WritableByteChannel.
Create an Output Resource instance from an WritableByteChannel.
The opener param is a by-name argument an is use to open a new stream. In other words it is important to try and pass in a function for opening the stream rather than the already opened stream so that the returned Resource can be used multiple time
the function for opening a new WritableByteChannel
An optional parameter for specifying an additional action to perform as the Resource is closed. This action will be executed just before close. Close actions can also be added to existing Resources
an WritableByteChannelResource
Create an WriteChars Resource instance with conversion traits from an Writer.
Create an WriteChars Resource instance with conversion traits from an Writer.
The opener param is a by-name argument an is use to open a new stream. In other words it is important to try and pass in a function for opening the stream rather than the already opened stream so that the returned Resource can be used multiple time
the function for opening a new Writer
An optional parameter for specifying an additional action to perform as the Resource is closed. This action will be executed just before close. Close actions can also be added to existing Resources
an WriterResource
Returns a representation that corresponds to the dynamic class of the receiver object.
Returns a representation that corresponds to the dynamic class of the receiver object.
The nature of the representation is platform dependent.
a representation that corresponds to the dynamic class of the receiver object.
Returns a hash code value for the object.
Returns a hash code value for the object.
The default hashing algorithm is platform dependent.
Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet
not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0.
However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have
identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure
to verify that the behavior is consistent with the equals method.
the hash code value for the object.
This method is used to test whether the dynamic type of the receiver object is T0.
This method is used to test whether the dynamic type of the receiver object is T0.
Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression
1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will
return true. In the latter example, because the type argument is erased as part of compilation it is not
possible to check whether the contents of the list are of the requested typed.
true if the receiver object is an instance of erasure of type T0; false otherwise.
o.ne(arg0) is the same as !(o.eq(arg0)).
o.ne(arg0) is the same as !(o.eq(arg0)).
the object to compare against this object for reference dis-equality.
false if the argument is not a reference to the receiver object; true otherwise.
Wakes up a single thread that is waiting on the receiver object's monitor.
Wakes up a single thread that is waiting on the receiver object's monitor.
Wakes up all threads that are waiting on the receiver object's monitor.
Wakes up all threads that are waiting on the receiver object's monitor.
Returns a string representation of the object.
Returns a string representation of the object.
The default representation is platform dependent.
a string representation of the object.
Defines several factory methods for creating instances of Resource.
Note: It is very important to try an pass a method that creates/opens the underlying resource or the actual creation code as the opener. This is important so that the resource can be used more than once. If an opened resource is passed to the factory method the resulting resource can only be used once since it closes the resource when it is closed.
Example:
val URL = new URL("http://scala-lang.org") val resource: Resource[InputStream] = Resource.fromInputStream(url.openStream).buffered