Packages

  • package root
    Definition Classes
    root
  • package scales

    Scales Xml provides both a more flexible approach to XML handling and a simplified way of interacting with XML.

    Scales Xml provides both a more flexible approach to XML handling and a simplified way of interacting with XML.

    It fits nicely with the Java APIs you know, TrAX and javax.xml.validation for example, allowing you to run XSLTs and convert to and from Scales XML and other DOMs.

    It also provides a far more XPath like experience than the normal Scala XML, Paths look like XPaths and work like them too (with many of the same functions and axes).

    Definition Classes
    root
  • package utils

    The scales.utils packages provide the basis functionality for scales.xml.

    The scales.utils packages provide the basis functionality for scales.xml.

    The Tree an Path collections that underpin the XML model, as well as the iteratee functionality are located in the relevant sub-packages.

    The package object itself pulls in the main utility functions for tree, path and iteratee handling. Import the scales.utils.ScalesUtils object implicit members to provide the path & and | extension functions, the iteratorEnumerator and the +:+ lazy appender for scalaz.EphemeralStream.

    Definition Classes
    scales
  • package resources
    Definition Classes
    utils
  • CloseOnNeed
  • Creator
  • IsClosed
  • Loaner
  • Pool
  • SimpleUnboundedPool
t

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
DataChunker, ProxiedCloseOnNeedInputStream, ProxiedCloseOnNeedReader, ReadableByteChannelWrapper, ReadableByteChannelWrapperBase, ByteSourceUser, CharacterSourceUser, SourceUser
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CloseOnNeed
  2. IsClosed
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def doClose: Unit
    Attributes
    protected

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def ++(close2: CloseOnNeed): CloseOnNeed
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  7. 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.

  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def isClosed: Boolean
    Definition Classes
    CloseOnNeed → IsClosed
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from IsClosed

Inherited from AnyRef

Inherited from Any

Ungrouped