akka.japi

JavaPartialFunction

Related Docs: object JavaPartialFunction | package japi

abstract class JavaPartialFunction[A, B] extends AbstractPartialFunction[A, B]

Helper for implementing a *pure* partial function: it will possibly be invoked multiple times for a single “application”, because its only abstract method is used for both isDefinedAt() and apply(); the former is mapped to isCheck == true and the latter to isCheck == false for those cases where this is important to know.

Failure to match is signaled by throwing noMatch(), i.e. not returning normally (the exception used in this case is pre-allocated, hence not that expensive).

new JavaPartialFunction<Object, String>() {
  public String apply(Object in, boolean isCheck) {
    if (in instanceof TheThing) {
      if (isCheck) return null; // to spare the expensive or side-effecting code
      return doSomethingWithTheThing((TheThing) in);
    } else {
      throw noMatch();
    }
  }
}

The typical use of partial functions from Akka looks like the following:

if (pf.isDefinedAt(x)) {
  pf.apply(x);
}

i.e. it will first call PurePartialFunction.apply(x, true) and if that does not throw noMatch() it will continue with calling PurePartialFunction.apply(x, false).

Source
JavaAPI.scala
Linear Supertypes
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. JavaPartialFunction
  2. AbstractPartialFunction
  3. PartialFunction
  4. Function1
  5. AnyRef
  6. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new JavaPartialFunction()

Abstract Value Members

  1. abstract def apply(x: A, isCheck: Boolean): B

    Annotations
    @throws( classOf[Exception] )

Concrete Value Members

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

    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from JavaPartialFunction[A, B] to any2stringadd[JavaPartialFunction[A, B]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (JavaPartialFunction[A, B], B)

    Implicit information
    This member is added by an implicit conversion from JavaPartialFunction[A, B] to ArrowAssoc[JavaPartialFunction[A, B]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  6. def andThen[C](k: (B) ⇒ C): PartialFunction[A, C]

    Definition Classes
    PartialFunction → Function1
  7. final def apply(x: A): B

    Definition Classes
    JavaPartialFunction → AbstractPartialFunction → Function1
  8. final def applyOrElse[A1 <: A, B1 >: B](x: A1, default: (A1) ⇒ B1): B1

    Definition Classes
    JavaPartialFunction → PartialFunction
  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def compose[A](g: (A) ⇒ A): (A) ⇒ B

    Definition Classes
    Function1
    Annotations
    @unspecialized()
  12. def ensuring(cond: (JavaPartialFunction[A, B]) ⇒ Boolean, msg: ⇒ Any): JavaPartialFunction[A, B]

    Implicit information
    This member is added by an implicit conversion from JavaPartialFunction[A, B] to Ensuring[JavaPartialFunction[A, B]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (JavaPartialFunction[A, B]) ⇒ Boolean): JavaPartialFunction[A, B]

    Implicit information
    This member is added by an implicit conversion from JavaPartialFunction[A, B] to Ensuring[JavaPartialFunction[A, B]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: ⇒ Any): JavaPartialFunction[A, B]

    Implicit information
    This member is added by an implicit conversion from JavaPartialFunction[A, B] to Ensuring[JavaPartialFunction[A, B]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): JavaPartialFunction[A, B]

    Implicit information
    This member is added by an implicit conversion from JavaPartialFunction[A, B] to Ensuring[JavaPartialFunction[A, B]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean

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

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from JavaPartialFunction[A, B] to StringFormat[JavaPartialFunction[A, B]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  20. final def getClass(): Class[_]

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

    Definition Classes
    AnyRef → Any
  22. final def isDefinedAt(x: A): Boolean

    Definition Classes
    JavaPartialFunction → PartialFunction
  23. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  24. def lift: (A) ⇒ scala.Option[B]

    Definition Classes
    PartialFunction
  25. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  28. def orElse[A1 <: A, B1 >: B](that: PartialFunction[A1, B1]): PartialFunction[A1, B1]

    Definition Classes
    PartialFunction
  29. def runWith[U](action: (B) ⇒ U): (A) ⇒ Boolean

    Definition Classes
    PartialFunction
  30. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  31. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. def [B](y: B): (JavaPartialFunction[A, B], B)

    Implicit information
    This member is added by an implicit conversion from JavaPartialFunction[A, B] to ArrowAssoc[JavaPartialFunction[A, B]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AbstractPartialFunction[A, B]

Inherited from PartialFunction[A, B]

Inherited from (A) ⇒ B

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from JavaPartialFunction[A, B] to any2stringadd[JavaPartialFunction[A, B]]

Inherited by implicit conversion StringFormat from JavaPartialFunction[A, B] to StringFormat[JavaPartialFunction[A, B]]

Inherited by implicit conversion Ensuring from JavaPartialFunction[A, B] to Ensuring[JavaPartialFunction[A, B]]

Inherited by implicit conversion ArrowAssoc from JavaPartialFunction[A, B] to ArrowAssoc[JavaPartialFunction[A, B]]

Ungrouped