spray.json.lenses

Lens

trait Lens[M[_]] extends UpdateLens with ReadLens[M]

A Lens combines read and update functions of UpdateLens and ReadLens into combinable chunks.

A lens can either operate on a scalar value, or on an optional value, or on a sequence value. This is denoted by the M[_] type constructor.

Linear Supertypes
ReadLens[M], UpdateLens, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Lens
  2. ReadLens
  3. UpdateLens
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def !(op: Operation): Update

    Definition Classes
    UpdateLens
  2. abstract def /[M2[_], R[_]](next: Lens[M2])(implicit ev: Join[M2, M, R]): Lens[R]

    A shortcut for the combine lens which combines two lenses.

  3. abstract def get[T](value: JsValue)(implicit arg0: Reader[T]): M[T]

    Given a parent JsValue extracts and converts a JsValue into a value of type T or throws an exception.

    Given a parent JsValue extracts and converts a JsValue into a value of type T or throws an exception.

    Definition Classes
    ReadLens
  4. abstract def is[U](f: (U) ⇒ Boolean)(implicit arg0: Reader[U]): JsPred

    Lifts a predicate for a converted value for this lens up to the parent level.

    Lifts a predicate for a converted value for this lens up to the parent level. The returned predicate will return false for values which fail to read.

    Definition Classes
    ReadLens
  5. abstract def ops: Ops[M]

  6. abstract def retr: (JsValue) ⇒ Validated[M[JsValue]]

    Given a parent JsValue, tries to extract the child value.

    Given a parent JsValue, tries to extract the child value.

    returns

    Right(value) if the lens read succeeds. Left(error) if the lens read fails.

    Definition Classes
    ReadLens
  7. abstract def toSeq: Lens[Seq]

  8. abstract def tryGet[T](value: JsValue)(implicit arg0: Reader[T]): Validated[M[T]]

    Given a parent JsValue extracts and tries to convert the JsValue into a value of type T

    Given a parent JsValue extracts and tries to convert the JsValue into a value of type T

    Definition Classes
    ReadLens
  9. abstract def updated(f: Operation)(parent: JsValue): SafeJsValue

    Applies function f on the child of the parent denoted by this UpdateLens and returns a Right of the parent with the child element updated.

    Applies function f on the child of the parent denoted by this UpdateLens and returns a Right of the parent with the child element updated.

    The value passed to f may be Left(e) if the child could not be found in which case particular operations may still succeed. Function f may return Left(error) in case the operation fails.

    updated returns Left(error) if the update operation or any of any intermediate lens fails.

    Definition Classes
    UpdateLens

Concrete Value Members

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

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

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

    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  5. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

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

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

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

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

    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  15. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  16. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from ReadLens[M]

Inherited from UpdateLens

Inherited from AnyRef

Inherited from Any

Ungrouped