Class/Object

argonaut

Cursor

Related Docs: object Cursor | package argonaut

Permalink

sealed abstract class Cursor extends Product with Serializable

Represents a position in a JSON value and allows moving around the JSON value. Also known as a "zipper." The cursor has a focus representing the current position being referred to by the cursor. Users may update the focus using withFocus (or the >-> alias) and move the cursor around with left, right, field, downArray, downField and up.

Source
Cursor.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Cursor
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def canEqual(that: Any): Boolean

    Permalink
    Definition Classes
    Equals
  2. abstract def productArity: Int

    Permalink
    Definition Classes
    Product
  3. abstract def productElement(n: Int): Any

    Permalink
    Definition Classes
    Product

Concrete Value Members

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. def --(q: Json.JsonField): Option[Cursor]

    Permalink

    Move the cursor to the given sibling field in a JSON object (alias for field).

  4. def --\(q: Json.JsonField): Option[Cursor]

    Permalink

    Move the cursor down to a JSON object at the given field (alias for downField).

  5. def -<-:(n: Int): Option[Cursor]

    Permalink

    Move the cursor left in a JSON array the given number of times.

    Move the cursor left in a JSON array the given number of times. A negative value will move the cursor right (alias for leftN).

  6. def -\(p: (Json) ⇒ Boolean): Option[Cursor]

    Permalink

    Move the cursor down to a JSON array at the first element satisfying the given predicate (alias for downAt).

  7. def :->-(n: Int): Option[Cursor]

    Permalink

    Move the cursor right in a JSON array the given number of times.

    Move the cursor right in a JSON array the given number of times. A negative value will move the cursor left (alias for rightN).

  8. def :->?(p: (Json) ⇒ Boolean): Option[Cursor]

    Permalink

    Move the cursor right in a JSON array until the given predicate matches the focus (alias for rightAt).

  9. def :=(j: Json): Cursor

    Permalink

    Set the focus to the given value (alias for set).

  10. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  11. def =\(n: Int): Option[Cursor]

    Permalink

    Move the cursor down to a JSON array at the given index (alias for downN).

  12. def >->(k: (Json) ⇒ Json): Cursor

    Permalink

    Update the focus with the given function (alias for withFocus).

  13. def ?<-:(p: (Json) ⇒ Boolean): Option[Cursor]

    Permalink

    Move the cursor left in a JSON array until the given predicate matches the focus (alias for leftAt).

  14. def \\: Option[Cursor]

    Permalink

    Move the cursor down to a JSON array at the first element (alias for downArray).

  15. def acursor: ACursor

    Permalink

    An ACursor for this cursor that tracks history.

  16. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  17. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. def context: Context

    Permalink

    Return the current context of the focus.

  19. def delete: Option[Cursor]

    Permalink

    Deletes the JSON value at focus and moves up to parent (alias for deleteGoParent).

  20. def deleteGoField(q: Json.JsonField): Option[Cursor]

    Permalink

    Deletes the JSON value at focus and moves to the given sibling field in a JSON object.

  21. def deleteGoFirst: Option[Cursor]

    Permalink

    Deletes the JSON value at focus and moves to the first in a JSON array.

  22. def deleteGoLast: Option[Cursor]

    Permalink

    Deletes the JSON value at focus and moves to the last in a JSON array.

  23. def deleteGoLeft: Option[Cursor]

    Permalink

    Deletes the JSON value at focus and moves to the left in a JSON array.

  24. def deleteGoParent: Option[Cursor]

    Permalink

    Deletes the JSON value at focus and moves up to parent (alias for unary_!).

  25. def deleteGoRight: Option[Cursor]

    Permalink

    Deletes the JSON value at focus and moves to the right in a JSON array.

  26. def deleteLefts: Option[Cursor]

    Permalink

    Deletes all JSON values to left of focus in a JSON array.

  27. def deleteRights: Option[Cursor]

    Permalink

    Deletes all JSON values to right of focus in a JSON array.

  28. def downArray: Option[Cursor]

    Permalink

    Move the cursor down to a JSON array at the first element (alias for \\).

  29. def downAt(p: (Json) ⇒ Boolean): Option[Cursor]

    Permalink

    Move the cursor down to a JSON array at the first element satisfying the given predicate (alias for -\).

  30. def downField(q: Json.JsonField): Option[Cursor]

    Permalink

    Move the cursor down to a JSON object at the given field (alias for --\).

  31. def downN(n: Int): Option[Cursor]

    Permalink

    Move the cursor down to a JSON array at the given index (alias for =\).

  32. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  34. def field(q: Json.JsonField): Option[Cursor]

    Permalink

    Move the cursor to the given sibling field in a JSON object (alias for --).

  35. def fieldSet: Option[Set[Json.JsonField]]

    Permalink

    All field names in a JSON object.

  36. def fields: Option[List[Json.JsonField]]

    Permalink

    All field names in a JSON object.

  37. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  38. def find(p: (Json) ⇒ Boolean): Option[Cursor]

    Permalink

    Find the first element at or to the right of focus in a JSON array where the given predicate matches the focus.

  39. def first: Option[Cursor]

    Permalink

    Move the cursor to the first in a JSON array.

  40. def focus: Json

    Permalink

    Return the current focus.

  41. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    AnyRef → Any
  43. def hcursor: HCursor

    Permalink

    A HCursor for this cursor that tracks history.

  44. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  45. def last: Option[Cursor]

    Permalink

    Move the cursor to the last in a JSON array.

  46. def left: Option[Cursor]

    Permalink

    Move the cursor left in a JSON array.

  47. def leftAt(p: (Json) ⇒ Boolean): Option[Cursor]

    Permalink

    Move the cursor left in a JSON array until the given predicate matches the focus (alias for ?<-:).

  48. def leftN(n: Int): Option[Cursor]

    Permalink

    Move the cursor left in a JSON array the given number of times.

    Move the cursor left in a JSON array the given number of times. A negative value will move the cursor right (alias for -<-:).

  49. def lefts: Option[Json.JsonArray]

    Permalink

    Return the values left of focus in a JSON array.

  50. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  51. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  52. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  53. def productIterator: Iterator[Any]

    Permalink
    Definition Classes
    Product
  54. def productPrefix: String

    Permalink
    Definition Classes
    Product
  55. def right: Option[Cursor]

    Permalink

    Move the cursor right in a JSON array.

  56. def rightAt(p: (Json) ⇒ Boolean): Option[Cursor]

    Permalink

    Move the cursor right in a JSON array until the given predicate matches the focus (alias for :->?).

  57. def rightN(n: Int): Option[Cursor]

    Permalink

    Move the cursor right in a JSON array the given number of times.

    Move the cursor right in a JSON array the given number of times. A negative value will move the cursor left (alias for :->-).

  58. def rights: Option[Json.JsonArray]

    Permalink

    Return the values right of focus in a JSON array.

  59. def set(j: Json): Cursor

    Permalink

    Set the focus to the given value (alias for :=).

  60. def setLefts(x: List[Json]): Option[Cursor]

    Permalink

    Set the values to the left of focus in a JSON array.

  61. def setRights(x: List[Json]): Option[Cursor]

    Permalink

    Set the values to the right of focus in a JSON array.

  62. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  63. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  64. def unary_!: Option[Cursor]

    Permalink

    Deletes the JSON value at focus and moves up to parent (alias for deleteGoParent).

  65. def unary_-: Json

    Permalink

    Unapplies the cursor to the top-level parent (alias for undo).

  66. def undo: Json

    Permalink

    Unapplies the cursor to the top-level parent (alias for unary_-).

  67. def up: Option[Cursor]

    Permalink

    Move the cursor up one step to the parent context.

  68. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  71. def withFocus(k: (Json) ⇒ Json): Cursor

    Permalink

    Update the focus with the given function (alias for >->).

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped