Apache Pekko 2.0.0-M3+222-b197663b-SNAPSHOT - org.apache.pekko.util.Switch Apache Pekko2.0.0-M3+222-b197663b-SNAPSHOT < Back  Packages  package root Definition Classesroot  package org Definition Classesroot  package apache Definition Classesorg  package pekko Definition Classesapache  package util Definition Classespekko BoundedBlockingQueue BoxedType ByteIterator ByteString ByteStringBuilder ClassLoaderObjectInputStream CompactByteString ConcurrentMultiMap HashCode Helpers Index LineNumbers ManifestInfo MessageBuffer MessageBufferMap NanoTimeTokenBucket OptionalUtil PriorityQueueStabilizer StablePriorityBlockingQueue StablePriorityQueue Subclassification Switch Timeout TypedMultiMap UUIDComparator Unsafe Version WallClock c org.apache.pekko.utilSwitch class Switch extends AnyRef An atomic switch that can be either on or off SourceLockUtil.scala Linear Supertypes AnyRef, Any Type Hierarchy  Ordering Alphabetic By Inheritance Inherited Switch AnyRef Any Implicitly by any2stringadd by StringFormat by Ensuring by ArrowAssoc Hide All Show All Visibility Public Protected Instance Constructors  new Switch(startAsOn: Boolean = false) Value Members  final def !=(arg0: Any): Boolean Definition ClassesAnyRef → Any  final def ##: Int Definition ClassesAnyRef → Any  def +(other: String): String ImplicitThis member is added by an implicit conversion from Switch toany2stringadd[Switch] performed by method any2stringadd in scala.Predef.Definition Classesany2stringadd  def ->[B](y: B): (Switch, B) ImplicitThis member is added by an implicit conversion from Switch toArrowAssoc[Switch] performed by method ArrowAssoc in scala.Predef.Definition ClassesArrowAssocAnnotations@inline()  final def ==(arg0: Any): Boolean Definition ClassesAnyRef → Any  final def asInstanceOf[T0]: T0 Definition ClassesAny  def clone(): AnyRef Attributesprotected[lang] Definition ClassesAnyRefAnnotations@throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()  def ensuring(cond: (Switch) => Boolean, msg: => Any): Switch ImplicitThis member is added by an implicit conversion from Switch toEnsuring[Switch] performed by method Ensuring in scala.Predef.Definition ClassesEnsuring  def ensuring(cond: (Switch) => Boolean): Switch ImplicitThis member is added by an implicit conversion from Switch toEnsuring[Switch] performed by method Ensuring in scala.Predef.Definition ClassesEnsuring  def ensuring(cond: Boolean, msg: => Any): Switch ImplicitThis member is added by an implicit conversion from Switch toEnsuring[Switch] performed by method Ensuring in scala.Predef.Definition ClassesEnsuring  def ensuring(cond: Boolean): Switch ImplicitThis member is added by an implicit conversion from Switch toEnsuring[Switch] performed by method Ensuring in scala.Predef.Definition ClassesEnsuring  final def eq(arg0: AnyRef): Boolean Definition ClassesAnyRef  def equals(arg0: AnyRef): Boolean Definition ClassesAnyRef → Any  def fold[T](on: => T)(off: => T): T Executes the provided callbacks depending on if the switch is either on or off waiting for any pending changes to happen before (locking) Be careful of longrunning or blocking within the provided action as it can lead to deadlocks or bad performance  final def getClass(): Class[_ <: AnyRef] Definition ClassesAnyRef → AnyAnnotations@IntrinsicCandidate() @native()  def hashCode(): Int Definition ClassesAnyRef → AnyAnnotations@IntrinsicCandidate() @native()  def ifOff(action: => Unit): Boolean Executes the provided action and returns if the action was executed or not, if the switch is IMMEDIATELY off (i.e. Executes the provided action and returns if the action was executed or not, if the switch is IMMEDIATELY off (i.e. no lock involved)  def ifOffYield[T](action: => T): Option[T] Executes the provided action and returns its value if the switch is IMMEDIATELY off (i.e. Executes the provided action and returns its value if the switch is IMMEDIATELY off (i.e. no lock involved)  def ifOn(action: => Unit): Boolean Executes the provided action and returns if the action was executed or not, if the switch is IMMEDIATELY on (i.e. Executes the provided action and returns if the action was executed or not, if the switch is IMMEDIATELY on (i.e. no lock involved)  def ifOnYield[T](action: => T): Option[T] Executes the provided action and returns its value if the switch is IMMEDIATELY on (i.e. Executes the provided action and returns its value if the switch is IMMEDIATELY on (i.e. no lock involved)  final def isInstanceOf[T0]: Boolean Definition ClassesAny  def isOff: Boolean Returns whether the switch is IMMEDIATELY off (no locking)  def isOn: Boolean Returns whether the switch is IMMEDIATELY on (no locking)  def locked[T](code: => T): T Executes the given code while holding this switch’s lock, i.e. Executes the given code while holding this switch’s lock, i.e. protected from concurrent modification of the switch status.  final def ne(arg0: AnyRef): Boolean Definition ClassesAnyRef  final def notify(): Unit Definition ClassesAnyRefAnnotations@IntrinsicCandidate() @native()  final def notifyAll(): Unit Definition ClassesAnyRefAnnotations@IntrinsicCandidate() @native()  def switchOff: Boolean Switches the switch off (if on), uses locking  def switchOff(action: => Unit): Boolean Executes the provided action if the lock is on under a lock, so be _very_ careful with longrunning/blocking operations in it Only executes the action if the switch is on, and switches it off immediately after obtaining the lock Will switch it back on if the provided action throws an exception  def switchOn: Boolean Switches the switch on (if off), uses locking  def switchOn(action: => Unit): Boolean Executes the provided action if the lock is off under a lock, so be _very_ careful with longrunning/blocking operations in it Only executes the action if the switch is off, and switches it on immediately after obtaining the lock Will switch it back off if the provided action throws an exception  final def synchronized[T0](arg0: => T0): T0 Definition ClassesAnyRef  def toString(): String Definition ClassesAnyRef → Any  def transcend(from: Boolean, action: => Unit): Boolean Attributesprotected  final def wait(arg0: Long, arg1: Int): Unit Definition ClassesAnyRefAnnotations@throws(classOf[java.lang.InterruptedException])  final def wait(arg0: Long): Unit Definition ClassesAnyRefAnnotations@throws(classOf[java.lang.InterruptedException]) @native()  final def wait(): Unit Definition ClassesAnyRefAnnotations@throws(classOf[java.lang.InterruptedException])  def whileOff(action: => Unit): Boolean Executes the provided action and returns if the action was executed or not, if the switch is off, waiting for any pending changes to happen before (locking) Be careful of longrunning or blocking within the provided action as it can lead to deadlocks or bad performance  def whileOffYield[T](action: => T): Option[T] Executes the provided action and returns its value if the switch is off, waiting for any pending changes to happen before (locking) Be careful of longrunning or blocking within the provided action as it can lead to deadlocks or bad performance  def whileOn(action: => Unit): Boolean Executes the provided action and returns if the action was executed or not, if the switch is on, waiting for any pending changes to happen before (locking) Be careful of longrunning or blocking within the provided action as it can lead to deadlocks or bad performance  def whileOnYield[T](action: => T): Option[T] Executes the provided action and returns its value if the switch is on, waiting for any pending changes to happen before (locking) Be careful of longrunning or blocking within the provided action as it can lead to deadlocks or bad performance Deprecated Value Members  def finalize(): Unit Attributesprotected[lang] Definition ClassesAnyRefAnnotations@throws(classOf[java.lang.Throwable]) @Deprecated Deprecated (Since version 9)  def formatted(fmtstr: String): String ImplicitThis member is added by an implicit conversion from Switch toStringFormat[Switch] performed by method StringFormat in scala.Predef.Definition ClassesStringFormatAnnotations@deprecated @inline() Deprecated (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.  def →[B](y: B): (Switch, B) ImplicitThis member is added by an implicit conversion from Switch toArrowAssoc[Switch] performed by method ArrowAssoc in scala.Predef.Definition ClassesArrowAssocAnnotations@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 AnyRef Inherited from Any Inherited by implicit conversion any2stringadd fromSwitch to any2stringadd[Switch] Inherited by implicit conversion StringFormat fromSwitch to StringFormat[Switch] Inherited by implicit conversion Ensuring fromSwitch to Ensuring[Switch] Inherited by implicit conversion ArrowAssoc fromSwitch to ArrowAssoc[Switch] Ungrouped