Packages

  • package root
    Definition Classes
    root
  • package io
    Definition Classes
    root
  • package circe

    This is the API documentation for Circe, a JSON library for Scala and Scala.js.

    Overview

    This is the API documentation for Circe, a JSON library for Scala and Scala.js.

    The library is divided into a number of modules that either provide core functionality, support additional features via third-party dependencies, or facilitate integration with other libraries or frameworks.

    • numbers: core facilities for representing and parsing JSON numbers.
    • core: our JSON abstract syntax tree, our zipper-like cursor types, and our encoding and decoding type classes (and instances).
    • parser: JSON parsing support for both the Java Virtual Machine (using Jawn) and Scala.js (using the native JavaScript JSON parser).
    • testing: ScalaCheck Arbitrary instances for circe's JSON AST and other types, as well as other useful testing tools.
    • literal: JSON string interpolation and encoder and decoder instances for literal types.
    • generic: Shapeless-powered generic derivation for case classes and sealed trait hierarchies.
    • generic-extras: additional experimental generic derivation functionality (including some configurability).
    • pointer: A JSON Pointer implementation
    • pointer-literal: JSON Pointer string interpolation
    • shapes: encoders and decoders for Shapeless hlists, coproducts, records, and sized collections.
    • scodec: encoders and decoders for Scodec's BitVector and ByteVector.
    • refined: encoders and decoders for refined types.
    • spray: Spray marshaller conversions for Circe's type classes.

    Please refer to the documentation for a more detailed introduction to the library.

    Definition Classes
    io
  • package pointer
    Definition Classes
    circe
  • object Pointer
    Definition Classes
    pointer
  • Absolute
  • Relative

final class Absolute extends Pointer

Represents an absolute JSON Pointer.

Source
Pointer.scala
Linear Supertypes
Pointer, (ACursor) => ACursor, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Absolute
  2. Pointer
  3. Function1
  4. AnyRef
  5. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 Absolute toany2stringadd[Absolute] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Absolute, B)
    Implicit
    This member is added by an implicit conversion from Absolute toArrowAssoc[Absolute] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def andThen[A](g: (ACursor) => A): (ACursor) => A
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  7. def apply(c: ACursor): ACursor
    Definition Classes
    Absolute → Function1
  8. def asAbsolute: Option[Absolute]

    Return this pointer as a Pointer.Absolute if possible.

    Return this pointer as a Pointer.Absolute if possible.

    Definition Classes
    Absolute → Pointer
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def asRelative: Option[Relative]

    Return this pointer as a Pointer.Relative if possible.

    Return this pointer as a Pointer.Relative if possible.

    Definition Classes
    Absolute → Pointer
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  12. def compose[A](g: (A) => ACursor): (A) => ACursor
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  13. def ensuring(cond: (Absolute) => Boolean, msg: => Any): Absolute
    Implicit
    This member is added by an implicit conversion from Absolute toEnsuring[Absolute] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: (Absolute) => Boolean): Absolute
    Implicit
    This member is added by an implicit conversion from Absolute toEnsuring[Absolute] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean, msg: => Any): Absolute
    Implicit
    This member is added by an implicit conversion from Absolute toEnsuring[Absolute] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean): Absolute
    Implicit
    This member is added by an implicit conversion from Absolute toEnsuring[Absolute] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(that: Any): Boolean
    Definition Classes
    Absolute → AnyRef → Any
  19. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  20. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Absolute toStringFormat[Absolute] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  21. final def get(input: Json): Either[PointerFailure, Json]

    Attempt to get the value at the location pointed to, returning the history if it doesn't exist.

    Attempt to get the value at the location pointed to, returning the history if it doesn't exist.

    Definition Classes
    Pointer
  22. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  23. def getOption(input: Json): Option[Json]

    Attempt to get the value at the location pointed to.

    Attempt to get the value at the location pointed to.

    Definition Classes
    Absolute → Pointer
    Note

    For absolute pointers this method may be faster than get or apply, since it does not have to track error locations.

  24. def hashCode(): Int
    Definition Classes
    Absolute → AnyRef → Any
  25. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  30. def toString(): String
    Definition Classes
    Absolute → Function1 → AnyRef → Any
  31. def tokens: Vector[String]
  32. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def →[B](y: B): (Absolute, B)
    Implicit
    This member is added by an implicit conversion from Absolute toArrowAssoc[Absolute] performed by method ArrowAssoc in scala.Predef.
    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 Pointer

Inherited from (ACursor) => ACursor

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromAbsolute to any2stringadd[Absolute]

Inherited by implicit conversion StringFormat fromAbsolute to StringFormat[Absolute]

Inherited by implicit conversion Ensuring fromAbsolute to Ensuring[Absolute]

Inherited by implicit conversion ArrowAssoc fromAbsolute to ArrowAssoc[Absolute]

Ungrouped