json

Type Members

implicit class AnyValJSEx[T] extends AnyRef

This is the class extension that allows you to use the .js method on any value
This is the class extension that allows you to use the .js method on any value

Definition Classes
Implicits
abstract class FieldAccessor[T, U] extends Product2[Class[T], String]

Base accessor class for field accessors in objects (seen via case class macro generally).
Base accessor class for field accessors in objects (seen via case class macro generally).
The contains extended run-time info such as field name, field defaults, type access etc.
T
type of class that owns the fields
U
type of the field
type FieldAccessorAnnotation = json.internal.FieldAccessorAnnotation

Base type of all annotations, useful when reflecting annos in json.FieldAccessor
Base type of all annotations, useful when reflecting annos in json.FieldAccessor

Definition Classes
JSONAnnotations
trait Implicits extends AnyRef
abstract class JArray extends JValue with JArrayLike with JArrayBase

JSON array as ordered sequence of JValues
sealed abstract class JBoolean extends JValue with JBooleanBase

Base type for JSON primitives JTrue and JFalse
case class JDynamic(value: JValue) extends Dynamic with Product with Serializable
sealed abstract class JNumber extends JValue with JNumberBase

JSON numeric value (stored as 64-bit double)
final case class JObject extends JValue with Iterable[Pair] with IterableLike[Pair, JObject] with JObjectLike with JObjectBase with Product with Serializable

JSON object as ordered pairs of String -> JValue
type JSONAccessor[T] = JSONAccessorProducer[T, JValue]

JSONAccessor is shorthand for a JSONAccessorProducer of generic JValue type
JSONAccessor is shorthand for a JSONAccessorProducer of generic JValue type

Annotations
@implicitNotFound( ... )
trait JSONAccessorProducer[T, +JV <: JValue] extends CreateJSON[T, JV]

Annotations
@implicitNotFound( ... )
case class JSONBuilderSettings(spaceString: String, newLineString: String, tabString: String) extends Product with Serializable
type JSONException = json.exceptions.JSONException

Base type for all JSON exceptions.
Base type for all JSON exceptions. All exceptions are based off of case classes.
implicit class JSONStringOps extends AnyRef

Definition Classes
Implicits
final case class JString(value: String) extends JValue with Iterable[JString] with JStringLike with JStringBase with Product with Serializable

JSON String value
sealed abstract class JValue extends JValueLike with JValueBase

This is the base type for all JSON values.
This is the base type for all JSON values. JValue includes JS-like methods for handling data in generic JS type. Like JS, some of these methods are convenient but definitely not type safe, and some may result in odd type conversion or exceptions. For type-safe handling of JValues, consider using pattern matching the good ol' scala way.
trait ObjectAccessor[T] extends JSONAccessorProducer[T, JObject]

ObjectAccessor is a JSONAccessor for objects that have named fields.
ObjectAccessor is a JSONAccessor for objects that have named fields. Generally these are mostly seen as auto-generated json.internal.CaseClassObjectAccessor case class accessors. Extend this if you need to make a custom accessor that has named fields.
T
The base type this accessor is for.
macro class accessor extends Annotation with StaticAnnotation

Automatically provides an implicit ObjectAccessor to a class companion object.
Automatically provides an implicit ObjectAccessor to a class companion object. Requires the macro paradise compiler plugin.

Annotations
@compileTimeOnly( ... ) @compileTimeOnly( ... )
type description = FieldDescriptionGeneric

Provide field description, useful when reflect on accessors for auto-gen docs, etc
Provide field description, useful when reflect on accessors for auto-gen docs, etc

Definition Classes
JSONAnnotations
type ephemeral = EphemeralGeneric

Marks an internal method/val to be emitted when serialized only, but not needed for construction (basically read only).
Marks an internal method/val to be emitted when serialized only, but not needed for construction (basically read only).
```
@json.accessor case class Foo(bar: String) {
  @json.ephemeral def twice = bar + bar
}
```
Definition Classes
JSONAnnotations
type name = FieldNameGeneric

Provide field name that will be used in the JSON.
Provide field name that will be used in the JSON. Useful when making case classes for existing JSON models that aren't camel cased.

Definition Classes
JSONAnnotations

Value Members

object Implicits extends Implicits
object JArray extends JArrayCompanion
object JBoolean
object JFalse extends JBoolean with Product with Serializable
lazy val JNaN: JNumber

Special NaN JNumber value
object JNull extends JValue with JNullBase with Product with Serializable

JSON null primitive
object JNumber
object JObject extends JObjectCompanion with Serializable
val JSONAccessor: JSONAccessorProducer.type

see JSONAccessorProducer
object JSONAccessorProducer
object JSONBuilderSettings extends Serializable
object JTrue extends JBoolean with Product with Serializable
object JUndefined extends JValue with JUndefinedBase with Product with Serializable

JS undefined primitive (not actually a JSON primitive)
object JValue extends JValueLikeCompanion
object ObjectAccessor
def accessorFor[T](x: T)(implicit acc: JSONAccessor[T]): JSONAccessor[T]
def accessorOf[T](implicit acc: JSONAccessor[T]): JSONAccessor[T]
object accessors extends Accessors
object annotations extends JSONAnnotations

Package space for all scala-json annotations
def createAccessor[T](toJ: (T) ⇒ JValue, fromJ: (JValue) ⇒ T)(implicit arg0: ClassTag[T]): JSONAccessor[T]

Create a simple JValue JSONAccessor out of 'to' and 'from' functions.
package exceptions
def fromJSON[T](jval: JValue)(implicit acc: JSONAccessor[T]): T
def toJSONString[T](obj: T)(implicit arg0: JSONAccessor[T]): String
package tools

package json

Overview

JValue Types

Type Members

implicit class AnyValJSEx[T] extends AnyRef

abstract class FieldAccessor[T, U] extends Product2[Class[T], String]

type FieldAccessorAnnotation = json.internal.FieldAccessorAnnotation

trait Implicits extends AnyRef

abstract class JArray extends JValue with JArrayLike with JArrayBase

sealed abstract class JBoolean extends JValue with JBooleanBase

case class JDynamic(value: JValue) extends Dynamic with Product with Serializable

sealed abstract class JNumber extends JValue with JNumberBase

final case class JObject extends JValue with Iterable[Pair] with IterableLike[Pair, JObject] with JObjectLike with JObjectBase with Product with Serializable

type JSONAccessor[T] = JSONAccessorProducer[T, JValue]

trait JSONAccessorProducer[T, +JV <: JValue] extends CreateJSON[T, JV]

case class JSONBuilderSettings(spaceString: String, newLineString: String, tabString: String) extends Product with Serializable

type JSONException = json.exceptions.JSONException

implicit class JSONStringOps extends AnyRef

final case class JString(value: String) extends JValue with Iterable[JString] with JStringLike with JStringBase with Product with Serializable

sealed abstract class JValue extends JValueLike with JValueBase

trait ObjectAccessor[T] extends JSONAccessorProducer[T, JObject]

macro class accessor extends Annotation with StaticAnnotation

type description = FieldDescriptionGeneric

type ephemeral = EphemeralGeneric

type name = FieldNameGeneric

Value Members

object Implicits extends Implicits

object JArray extends JArrayCompanion

object JBoolean

object JFalse extends JBoolean with Product with Serializable

lazy val JNaN: JNumber

object JNull extends JValue with JNullBase with Product with Serializable

object JNumber

object JObject extends JObjectCompanion with Serializable

val JSONAccessor: JSONAccessorProducer.type

object JSONAccessorProducer

object JSONBuilderSettings extends Serializable

object JTrue extends JBoolean with Product with Serializable

object JUndefined extends JValue with JUndefinedBase with Product with Serializable

object JValue extends JValueLikeCompanion

object ObjectAccessor

def accessorFor[T](x: T)(implicit acc: JSONAccessor[T]): JSONAccessor[T]

def accessorOf[T](implicit acc: JSONAccessor[T]): JSONAccessor[T]

object accessors extends Accessors

object annotations extends JSONAnnotations

def createAccessor[T](toJ: (T) ⇒ JValue, fromJ: (JValue) ⇒ T)(implicit arg0: ClassTag[T]): JSONAccessor[T]

package exceptions

def fromJSON[T](jval: JValue)(implicit acc: JSONAccessor[T]): T

def toJSONString[T](obj: T)(implicit arg0: JSONAccessor[T]): String

package tools

Inherited from Implicits

Inherited from JSONAnnotations

Inherited from AnyRef

Inherited from Any

Ungrouped