scalax.io

BufferableOutputResource

trait BufferableOutputResource [+C <: Closeable, +B <: Closeable] extends OutputResource[C] with Bufferable[OutputResource[B]] with ResourceOps[C, BufferableOutputResource[C, B]]

A trait consisting of the Combination of OutputResource and Bufferable. Primary use is to simply the signature of the objects created by the Resource factory object.

A trait consisting of the Combination of OutputResource and Bufferable. Primary use is to simply the signature of the objects created by the Resource factory object.

linear super types: Bufferable[OutputResource[B]], OutputResource[C], Output, Resource[C], ResourceOps[C, BufferableOutputResource[C, B]], ManagedResourceOperations[C], ManagedResource[C], AnyRef, Any
known subclasses: WritableByteChannelResource, OutputStreamResource
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. BufferableOutputResource
  2. Bufferable
  3. OutputResource
  4. Output
  5. Resource
  6. ResourceOps
  7. ManagedResourceOperations
  8. ManagedResource
  9. AnyRef
  10. Any
Visibility
  1. Public
  2. All
Impl.
  1. Concrete
  2. Abstract

Value Members

  1. def ! : C @scala.util.continuations.cpsParam[Unit,Unit]

    definition classes: ManagedResourceOperations → ManagedResource
  2. def != ( arg0 : AnyRef ) : Boolean

    attributes: final
    definition classes: AnyRef
  3. def != ( arg0 : Any ) : Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality.

    returns

    false if the receiver object is equivalent to the argument; true otherwise.

    attributes: final
    definition classes: Any
  4. def ## () : Int

    attributes: final
    definition classes: AnyRef → Any
  5. def $asInstanceOf [T0] () : T0

    attributes: final
    definition classes: AnyRef
  6. def $isInstanceOf [T0] () : Boolean

    attributes: final
    definition classes: AnyRef
  7. def == ( arg0 : AnyRef ) : Boolean

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

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: AnyRef
  8. def == ( arg0 : Any ) : Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: Any
  9. def acquireAndGet [B] ( f : (C) ⇒ B ) : B

    definition classes: ManagedResourceOperations → ManagedResource
  10. def acquireFor [B] ( f : (C) ⇒ B ) : Either[List[Throwable], B]

    definition classes: Resource → ManagedResource
  11. def and [B] ( that : ManagedResource[B] ) : ManagedResource[(C, B)]

    definition classes: ManagedResourceOperations → ManagedResource
  12. def appendCloseAction [B >: C] ( newAction : (B) ⇒ Unit ) : BufferableOutputResource[C, B]

    Creates a CloseAction from the function and passes it to appendCloseAction(CloseAction)

    Creates a CloseAction from the function and passes it to appendCloseAction(CloseAction)

    newAction

    The new action to append

    returns

    a new instance with the added CloseAction *

    definition classes: ResourceOps
  13. def appendCloseAction [B >: C] ( newAction : CloseAction[B] ) : BufferableOutputResource[C, B]

    Add a CloseAction to the end of the CloseAction queue (the last action executed).

    Add a CloseAction to the end of the CloseAction queue (the last action executed).

    newAction

    The new action to append

    returns

    a new instance with the added CloseAction

    attributes: abstract
    definition classes: ResourceOps
  14. def asInstanceOf [T0] : T0

    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.

    returns

    the receiver object.

    attributes: final
    definition classes: Any
  15. def buffered : OutputResource[B]

    Obtain the buffered version of this object.

    Obtain the buffered version of this object.

    returns

    the buffered version of this object

    attributes: abstract
    definition classes: Bufferable
  16. def clone () : AnyRef

    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.

    returns

    a copy of the receiver object.

    attributes: protected[lang]
    definition classes: AnyRef
    annotations: @throws()
  17. def eq ( arg0 : AnyRef ) : Boolean

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

    arg0

    the object to compare against this object for reference equality.

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    attributes: final
    definition classes: AnyRef
  18. def equals ( arg0 : Any ) : Boolean

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

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef → Any
  19. def finalize () : Unit

    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.

    attributes: protected[lang]
    definition classes: AnyRef
    annotations: @throws()
  20. def flatMap [B, To] ( f : (C) ⇒ B )(implicit translator : CanSafelyFlatMap[B, To] ) : To

    definition classes: ManagedResourceOperations → ManagedResource
  21. def foreach ( f : (C) ⇒ Unit ) : Unit

    definition classes: ManagedResourceOperations → ManagedResource
  22. def getClass () : java.lang.Class[_]

    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.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef
  23. def hashCode () : Int

    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.

    returns

    the hash code value for the object.

    definition classes: AnyRef → Any
  24. def isInstanceOf [T0] : Boolean

    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.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    attributes: final
    definition classes: Any
  25. def map [B, To] ( f : (C) ⇒ B )(implicit translator : CanSafelyMap[B, To] ) : To

    definition classes: ManagedResourceOperations → ManagedResource
  26. def ne ( arg0 : AnyRef ) : Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality.

    returns

    false if the argument is not a reference to the receiver object; true otherwise.

    attributes: final
    definition classes: AnyRef
  27. def notify () : Unit

    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.

    attributes: final
    definition classes: AnyRef
  28. def notifyAll () : Unit

    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.

    attributes: final
    definition classes: AnyRef
  29. def open () : C

    Creates a new instance of the underlying resource (or opens it).

    Creates a new instance of the underlying resource (or opens it). Sometimes the code block used to create the Resource is non-reusable in which case this Resource can only be used once. This is not recommended. When creating a resource it is recommended to pass the code block for creating the resource to the resource so that the resource can be reused. Of course this is not always possible

    This method should only be used with care in cases when Automatic Resource Management cannot be used because the InputStream must be closed manually.

    This is public only to permit interoperability with certain Java APIs. A better pattern of use should be:

    resource.acquireFor {
      // call java API
    }
    

    or

    val calculatedResult = resource.acquireAndGet {
      // cal java API that returns a result
    }
    
    returns

    the actual resource that has been openned

    attributes: abstract
    definition classes: Resource
  30. def outputStream : OutputResource[OutputStream]

    Obtain the OutputStreamResource(typically) version of this object.

    Obtain the OutputStreamResource(typically) version of this object.

    returns

    the OutputStreamResource(typically) version of this object.

    attributes: abstract
    definition classes: OutputResource
  31. def prependCloseAction [B >: C] ( newAction : (B) ⇒ Unit ) : BufferableOutputResource[C, B]

    Creates a CloseAction from the function and passes it to prependCloseAction(CloseAction)

    Creates a CloseAction from the function and passes it to prependCloseAction(CloseAction)

    newAction

    The new action to prepend

    returns

    a new instance with the added CloseAction *

    definition classes: ResourceOps
  32. def prependCloseAction [B >: C] ( newAction : CloseAction[B] ) : BufferableOutputResource[C, B]

    Add a CloseAction to the front of the CloseAction queue.

    Add a CloseAction to the front of the CloseAction queue.

    newAction

    The new action to prepend

    returns

    a new instance with the added CloseAction

    attributes: abstract
    definition classes: ResourceOps
  33. def reflect [B] : C @util.continuations.package.cps[Either[List[Throwable],B]]

    definition classes: ManagedResourceOperations → ManagedResource
  34. def synchronized [T0] ( arg0 : ⇒ T0 ) : T0

    attributes: final
    definition classes: AnyRef
  35. def toString () : String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

    a string representation of the object.

    definition classes: AnyRef → Any
  36. def toTraversable [B] ( f : (C) ⇒ TraversableOnce[B] ) : Traversable[B]

    definition classes: ManagedResourceOperations → ManagedResource
  37. def underlyingOutput : OutputResource[OutputStream]

    attributes: protected abstract
    definition classes: Output
  38. def wait () : Unit

    attributes: final
    definition classes: AnyRef
    annotations: @throws()
  39. def wait ( arg0 : Long , arg1 : Int ) : Unit

    attributes: final
    definition classes: AnyRef
    annotations: @throws()
  40. def wait ( arg0 : Long ) : Unit

    attributes: final
    definition classes: AnyRef
    annotations: @throws()
  41. def writableByteChannel : OutputResource[WritableByteChannel]

    Obtain the scalax.io.WritableByteChannel(typically) version of this object.

    Obtain the scalax.io.WritableByteChannel(typically) version of this object.

    returns

    the scalax.io.WritableByteChannel(typically) version of this object.

    attributes: abstract
    definition classes: OutputResource
  42. def write ( string : String )(implicit codec : Codec = Codec.default ) : Unit

    Writes a string.

    Writes a string.

    string

    the data to write

    codec

    the codec of the string to be written. The string will be converted to the encoding of sourceCodec Default is sourceCodec

    definition classes: Output
  43. def write [T] ( data : T )(implicit writer : OutputConverter[T] ) : Unit

    Write data to the underlying object.

    Write data to the underlying object. In the case of writing ints and bytes it is often recommended to write arrays of data since normally the underlying object can write arrays of bytes or integers most efficiently.

    Since Characters require a codec to write to an OutputStream characters cannot be written with this method unless a OutputWriterFunction.CharFunction object is provided as the writer.

    data

    The data to write to underlying object. Any data that has a resolvable OutputConverter can be written. See the OutputConverter object for the defined OutputConverter implementations and classes to assist implementing more.

    writer

    The strategy used to write the data to the underlying object. Many standard data-types are implicitly resolved and do not need to be supplied

    definition classes: Output
      see also:
    1. #writeChars for more on writing characters

  44. def writeChars ( characters : TraversableOnce[Char] )(implicit codec : Codec = Codec.default ) : Unit

    definition classes: Output
  45. def writeIntsAsBytes ( data : Int* ) : Unit

    Since the OutputConverter object defined for writing Ints encodes Ints using 4 bytes this method is provided to simply write an array of Ints as if they are Bytes.

    Since the OutputConverter object defined for writing Ints encodes Ints using 4 bytes this method is provided to simply write an array of Ints as if they are Bytes. In other words just taking the first byte. This is pretty common in Java.io style IO. IE

     outputStream.write(1) 
    

    1 is written as a single byte.

    definition classes: Output
  46. def writeStrings ( strings : Traversable[String] , separator : String = "" )(implicit codec : Codec = Codec.default ) : Unit

    Write several strings.

    Write several strings.

    strings

    The data to write

    separator

    A string to add between each string. It is not added to the before the first string or after the last.

    codec

    The codec of the strings to be written. The strings will be converted to the encoding of sourceCodec

    definition classes: Output
  47. def writer (implicit sourceCodec : Codec = Codec.default ) : WriteCharsResource[Writer]

    Obtain the WriteCharsResource version of this object.

    Obtain the WriteCharsResource version of this object.

    returns

    the WriteCharsResource version of this object.

    attributes: abstract
    definition classes: OutputResource

Inherited from Bufferable[OutputResource[B]]

Inherited from OutputResource[C]

Inherited from Output

Inherited from Resource[C]

Inherited from ResourceOps[C, BufferableOutputResource[C, B]]

Inherited from ManagedResourceOperations[C]

Inherited from ManagedResource[C]

Inherited from AnyRef

Inherited from Any