akka.japi

JavaPartialFunction

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 any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  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: AnyRef): Boolean

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

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

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

    Implicit information
    This member is added by an implicit conversion from JavaPartialFunction[A, B] to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. 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 any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

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

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

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

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

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

    Definition Classes
    Any
  12. def clone(): AnyRef

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

    Definition Classes
    Function1
    Annotations
    @unspecialized()
  14. 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 any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. 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 any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. 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 any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. 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 any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Definition Classes
    AnyRef
  33. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. 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 any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from JavaPartialFunction[A, B] to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (javaPartialFunction: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from JavaPartialFunction[A, B] to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (javaPartialFunction: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: JavaPartialFunction[A, B]

    Implicit information
    This member is added by an implicit conversion from JavaPartialFunction[A, B] to ArrowAssoc[JavaPartialFunction[A, B]] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (javaPartialFunction: ArrowAssoc[JavaPartialFunction[A, B]]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: 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 any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (javaPartialFunction: Ensuring[JavaPartialFunction[A, B]]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

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 StringAdd

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

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

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

Ungrouped