scales.utils.resources

CloseOnNeed

trait CloseOnNeed extends IsClosed

Mostly exists for pulling but it is general

We want to enable bracketing and a more orderly shutdown of resources from the input streams. Whilst the resource is closed automatically its not very helpful if you don't want to close it. Due to Sun bug: 6539065 we have to wrap the actual close. This allows us to decide IF we want to close.

So we cover three use cases here: * Enumeratees can bracket, if so desired * Streams of xml can be continuously plied for more xml messages * Users who want to manually close early can do so too.

As a note this fits very closely to the scala-arm stuff, which I happily use in another project. But it has two specific seperate use cases: * XmlPulls should be joinable as iterators ++ should ensure that the resources are closed * Additionally, however, closing on the resulting XmlPull should close the lot.

So we either override the ++ to behave differently or we abstract away using of the stream from closing it.

Self Type
CloseOnNeed
Linear Supertypes
IsClosed, AnyRef, Any
Known Subclasses
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. CloseOnNeed
  2. IsClosed
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def doClose: Unit

    Attributes
    protected

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def ++(close2: CloseOnNeed): CloseOnNeed

  5. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  6. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def closeResource: Unit

    Close the underlying something, but only do it once.

    Close the underlying something, but only do it once.

    This allows closing of an xml input stream directly after the end doc, but without disturbing the normal model.

  10. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  12. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  14. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  15. def isClosed: Boolean

    Definition Classes
    CloseOnNeedIsClosed
  16. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  18. final def notify(): Unit

    Definition Classes
    AnyRef
  19. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  20. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  21. def toString(): String

    Definition Classes
    AnyRef → Any
  22. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from IsClosed

Inherited from AnyRef

Inherited from Any

Ungrouped