Packages

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 JavaPartialFunction.apply(x, true) and if that does not throw noMatch() it will continue with calling JavaPartialFunction.apply(x, false).

Source
JavaAPI.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JavaPartialFunction
  2. AbstractPartialFunction
  3. PartialFunction
  4. Function1
  5. AnyRef
  6. Any
Implicitly
  1. by UnliftOps
  2. by any2stringadd
  3. by StringFormat
  4. by Ensuring
  5. by ArrowAssoc
  1. Hide All
  2. Show All
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
    This member is added by an implicit conversion from JavaPartialFunction[A, B] toany2stringadd[JavaPartialFunction[A, B]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (JavaPartialFunction[A, B], B)
    Implicit
    This member is added by an implicit conversion from JavaPartialFunction[A, B] toArrowAssoc[JavaPartialFunction[A, B]] performed by method ArrowAssoc in scala.Predef.This conversion will take place only if B is a subclass of scala.Option[Nothing] (B <: scala.Option[Nothing]).
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def andThen[C](k: PartialFunction[B, C]): PartialFunction[A, C]
    Definition Classes
    PartialFunction
  7. def andThen[C](k: (B) => C): PartialFunction[A, C]
    Definition Classes
    PartialFunction → Function1
  8. final def apply(x: A): B
    Definition Classes
    JavaPartialFunction → AbstractPartialFunction → Function1
  9. final def applyOrElse[A1 <: A, B1 >: B](x: A1, default: (A1) => B1): B1
    Definition Classes
    JavaPartialFunction → PartialFunction
  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  12. def compose[R](k: PartialFunction[R, A]): PartialFunction[R, B]
    Definition Classes
    PartialFunction
  13. def compose[A](g: (A) => A): (A) => B
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  14. def elementWise: ElementWiseExtractor[A, B]
    Definition Classes
    PartialFunction
  15. def ensuring(cond: (JavaPartialFunction[A, B]) => Boolean, msg: => Any): JavaPartialFunction[A, B]
    Implicit
    This member is added by an implicit conversion from JavaPartialFunction[A, B] toEnsuring[JavaPartialFunction[A, B]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: (JavaPartialFunction[A, B]) => Boolean): JavaPartialFunction[A, B]
    Implicit
    This member is added by an implicit conversion from JavaPartialFunction[A, B] toEnsuring[JavaPartialFunction[A, B]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean, msg: => Any): JavaPartialFunction[A, B]
    Implicit
    This member is added by an implicit conversion from JavaPartialFunction[A, B] toEnsuring[JavaPartialFunction[A, B]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: Boolean): JavaPartialFunction[A, B]
    Implicit
    This member is added by an implicit conversion from JavaPartialFunction[A, B] toEnsuring[JavaPartialFunction[A, B]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  21. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from JavaPartialFunction[A, B] toStringFormat[JavaPartialFunction[A, B]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  22. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  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
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  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. def unapply(a: A): scala.Option[B]
    Definition Classes
    PartialFunction
  35. def unlift: PartialFunction[A, B]
    Implicit
    This member is added by an implicit conversion from JavaPartialFunction[A, B] toUnliftOps[A, B] performed by method UnliftOps in scala.Function1.This conversion will take place only if B is a subclass of scala.Option[B] (B <: scala.Option[B]).
    Definition Classes
    UnliftOps
  36. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  37. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  38. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

  2. def [B](y: B): (JavaPartialFunction[A, B], B)
    Implicit
    This member is added by an implicit conversion from JavaPartialFunction[A, B] toArrowAssoc[JavaPartialFunction[A, B]] performed by method ArrowAssoc in scala.Predef.This conversion will take place only if B is a subclass of scala.Option[Nothing] (B <: scala.Option[Nothing]).
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AbstractPartialFunction[A, B]

Inherited from PartialFunction[A, B]

Inherited from (A) => B

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion UnliftOps fromJavaPartialFunction[A, B] to UnliftOps[A, B]

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

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

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

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

Ungrouped