org.scaladebugger.api.pipelines

Pipeline

class Pipeline[A, B] extends Closeable

Represents a pipeline of instructions used to perform a series of operations over an arbitrary collection of data.

A

The incoming data type

B

The outgoing data type

Linear Supertypes
Closeable, AutoCloseable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Pipeline
  2. Closeable
  3. AutoCloseable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

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. final def ==(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  6. def addChildPipeline[C](childPipeline: Pipeline[B, C]): Pipeline[B, C]

    Adds the specified pipeline as a child of this pipeline.

    Adds the specified pipeline as a child of this pipeline.

    C

    The outgoing type of the child pipeline

    childPipeline

    The pipeline to add as a child

    returns

    The added child pipeline

    Attributes
    protected
  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. def children: Seq[Pipeline[B, _]]

    Retrieves the collection of children pipelines for the current pipeline.

    Retrieves the collection of children pipelines for the current pipeline.

    returns

    The collection of pipelines that are children to this pipeline

  9. def clone(): AnyRef

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

    Closes the pipeline immediately.

    Closes the pipeline immediately. No data is provided.

    Definition Classes
    Pipeline → Closeable → AutoCloseable
  11. def close(now: Boolean = true, data: Any = null): Unit

    Closes the pipeline.

    Closes the pipeline.

    now

    If true, should perform the closing action immediately rather than on the next data fed through the pipeline

    data

    Any data to be provided to the close function

  12. def currentMetadata: Metadata

    Retrieves the current metadata at this stage in the pipeline.

    Retrieves the current metadata at this stage in the pipeline.

    returns

    The map of metadata

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

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

    Definition Classes
    AnyRef → Any
  15. def failed: Pipeline[Throwable, Throwable]

    Retrieves the failure route of the current pipeline stage.

    Retrieves the failure route of the current pipeline stage.

    returns

    The pipeline to process the throwable from the failure

  16. def filter(f: (B) ⇒ Boolean): Pipeline[B, B]

    Filters the output of this pipeline instance.

    Filters the output of this pipeline instance.

    f

    The function to use for filtering data (only true results will remain in output)

    returns

    The resulting pipeline instance with the filtered data

  17. def filterNot(f: (B) ⇒ Boolean): Pipeline[B, B]

    Filters the output of this pipeline instance.

    Filters the output of this pipeline instance.

    f

    The function to use for filtering data (only false results will remain in output)

    returns

    The resulting pipeline instance with the filtered data

  18. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. def flatMap[C](f: (B) ⇒ GenTraversableOnce[C]): Pipeline[B, C]

    Maps the output of this pipeline instance to new values and then flattens the results.

    Maps the output of this pipeline instance to new values and then flattens the results.

    C

    The resulting type of the new values

    f

    The function to use for mapping data to new values that will be flattened

    returns

    The resulting pipeline instance with the mapped and flattened data

  20. def foreach(f: (B) ⇒ Unit): Unit

    Applies the provided function to the output of this pipeline, returning nothing from the function.

    Applies the provided function to the output of this pipeline, returning nothing from the function.

    f

    The function to apply

  21. final def getClass(): Class[_]

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

    Definition Classes
    AnyRef → Any
  23. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  24. def map[C](f: (B) ⇒ C): Pipeline[B, C]

    Maps the output of this pipeline instance to new values.

    Maps the output of this pipeline instance to new values.

    C

    The resulting type of the new values

    f

    The function to use for mapping data to new values

    returns

    The resulting pipeline instance with the mapped data

    Note

    Inherits the close function of the pipeline.

  25. def metadata: Pipeline[B, (B, Metadata)]

    Retrieves the metadata route of the current pipeline stage.

    Retrieves the metadata route of the current pipeline stage.

    returns

    The pipeline to process the metadata for the pipeline, containing the data and metadata as a tuple

  26. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  27. def newPipeline[C, D](operation: Operation[C, D]): Pipeline[C, D]

    Creates a new pipeline using the given operation.

    Creates a new pipeline using the given operation. This is used to generate pipelines within the pipeline itself and can be overridden to generate a different kind of pipeline. It is recommended to override this method when subclassing pipeline.

    C

    The input type of the new pipeline

    D

    The output type of the new pipeline

    operation

    The operation to provide to the new pipeline

    returns

    The new pipeline

    Attributes
    protected
    Note

    This implementation passes down the current pipeline's close function and metadata map.

  28. def newPipeline[C, D](operation: Operation[C, D], closeFunc: (Option[Any]) ⇒ Unit, metadataMap: Metadata): Pipeline[C, D]

    Creates a new pipeline using the given operation.

    Creates a new pipeline using the given operation. This is used to generate pipelines within the pipeline itself and can be overridden to generate a different kind of pipeline. It is recommended to override this method when subclassing pipeline.

    C

    The input type of the new pipeline

    D

    The output type of the new pipeline

    operation

    The operation to provide to the new pipeline

    closeFunc

    The function used to close the new pipeline

    metadataMap

    The map of metadata to hold in the pipeline instance

    returns

    The new pipeline

    Attributes
    protected
  29. def noop(): Pipeline[B, B]

    Applies a no-op on the current pipeline.

    Applies a no-op on the current pipeline.

    returns

    The pipeline after a no-op has been applied

  30. final def notify(): Unit

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

    Definition Classes
    AnyRef
  32. val operation: Operation[A, B]

    The operation to apply to incoming data

  33. def process(data: A*): Try[Seq[B]]

    Processes the provided data through this specific pipeline instance and all subsequent children of this pipeline instance.

    Processes the provided data through this specific pipeline instance and all subsequent children of this pipeline instance. No parent pipeline instance will be used during the processing of the data.

    data

    The data to process

    returns

    If successful, the transformed collection of data at this specific pipeline instance, otherwise the thrown exception

  34. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  35. def toFuture: Future[B]

    Transforms the pipeline into a future that will be evaluated once and then closes the underlying pipeline.

    Transforms the pipeline into a future that will be evaluated once and then closes the underlying pipeline.

    returns

    The future representing this pipeline

  36. def toString(): String

    Definition Classes
    AnyRef → Any
  37. def transform[C](operation: Operation[B, C]): Pipeline[B, C]

    Transforms the output of this pipeline using the provided operation.

    Transforms the output of this pipeline using the provided operation.

    C

    The resulting type of the output from the operation

    operation

    The operation to use to transform the output of this pipeline instance

    returns

    The resulting pipeline instance from applying the operation

    Note

    Inherits the close function of the pipeline.

  38. def unionInput(other: Pipeline[A, _]): Pipeline[A, A]

    Unions this pipeline with another pipeline that has the same input such that input from either pipeline is used for both.

    Unions this pipeline with another pipeline that has the same input such that input from either pipeline is used for both.

    other

    The other pipeline whose input to union together

    returns

    The unioned pipeline

  39. def unionOutput(other: Pipeline[_, B]): Pipeline[B, B]

    Unions this pipeline with another pipeline that has the same output such that output from either pipeline flows through the union.

    Unions this pipeline with another pipeline that has the same output such that output from either pipeline flows through the union.

    other

    The other pipeline to whose output to union together

    returns

    The unioned pipeline

  40. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. def withMetadata(metadataMap: Metadata): Pipeline[B, B]

    Adds additional metadata by creating a new stage in the pipeline with the additional metadata merged with the existing metadata.

    Adds additional metadata by creating a new stage in the pipeline with the additional metadata merged with the existing metadata.

    metadataMap

    The new metadata to add to future pipeline stages

    returns

    The resulting pipeline instance with the updated metadata

Inherited from Closeable

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped