util

Type Members

class AlternativeJsonKey extends Annotation with Annotation with ClassfileAnnotation
class AlternativeJsonKeys extends Annotation with Annotation with ClassfileAnnotation
macro class AutomaticJsonCodec extends Annotation with StaticAnnotation

Add implicit com.rojoma.json.v3.codec.JsonEncode and com.rojoma.json.v3.codec.JsonDecode instances to the annotated class.
Add implicit com.rojoma.json.v3.codec.JsonEncode and com.rojoma.json.v3.codec.JsonDecode instances to the annotated class.

Annotations
@compileTimeOnly( ... ) @compileTimeOnly( ... )
Note
when using this macro, annotated case classes must specify context bounds explicitly rather than using ":" syntax, due to https://github.com/scala/bug/issues/10589
macro class AutomaticJsonDecode extends Annotation with StaticAnnotation

Add an implicit com.rojoma.json.v3.codec.JsonDecode instance to the annotated class.
Add an implicit com.rojoma.json.v3.codec.JsonDecode instance to the annotated class.

Annotations
@compileTimeOnly( ... ) @compileTimeOnly( ... )
Note
when using this macro, annotated case classes must specify context bounds explicitly rather than using ":" syntax, due to https://github.com/scala/bug/issues/10589
macro class AutomaticJsonEncode extends Annotation with StaticAnnotation

Add an implicit com.rojoma.json.v3.codec.JsonEncode instance to the annotated class.
Add an implicit com.rojoma.json.v3.codec.JsonEncode instance to the annotated class.

Annotations
@compileTimeOnly( ... ) @compileTimeOnly( ... )
Note
when using this macro, annotated case classes must specify context bounds explicitly rather than using ":" syntax, due to https://github.com/scala/bug/issues/10589

case class InternalTag(fieldName: String, removeTagForSubcodec: Boolean = true) extends TagType with Product with Serializable

Specifies that the base codec should add (and possibly remove) an extra field to the objects generated by the subclasses' com.rojoma.json.v3.codec.JsonEncodes and com.rojoma.json.v3.codec.JsonDecodes (and they must be objects).

Example:

abstract class Base
case class SubclassA(name: String) extends Base
case class SubclassB(x: Int, y: Int) extends Base
implicit val aCodec = SimpleJsonCodecBuilder[SubclassA].build("name", _.name)
implicit val bCodec = SimpleJsonCodecBuilder[SubclassB].build("x", _.x, "y", _.y)
val baseCodec = SimpleHierarchyCodecBuilder[Base](InternalTag("type")).
   branch[SubclassA]("a").
   branch[SubclassB]("b").
   build
println(baseCodec.encode(SubclassA("John"))) // { "type" : "a", "name" : "John" }
println(baseCodec.encode(SubclassB(1, 2))) // { "type" : "b", "x" : 1, "y" : 2 }

abstract class JArrayProducer extends AnyRef
final class JValueProducer extends AnyRef
class JsonCaseInsensitiveEnum extends Annotation with Annotation with ClassfileAnnotation
class JsonKey extends Annotation with Annotation with ClassfileAnnotation
class JsonKeyStrategy extends Annotation with Annotation with ClassfileAnnotation
class JsonTag extends Annotation with Annotation with ClassfileAnnotation
class LazyCodec extends Annotation with Annotation with ClassfileAnnotation
sealed abstract class NoTag extends AnyRef

Specifies that the base codec should not affect the subclasses' com.rojoma.json.v3.codec.JsonEncodes and com.rojoma.json.v3.codec.JsonDecodes at all and that the decoder should simply try each codec in turn, in the order they were provided to the builder, until it finds one that succeeds.
Specifies that the base codec should not affect the subclasses' com.rojoma.json.v3.codec.JsonEncodes and com.rojoma.json.v3.codec.JsonDecodes at all and that the decoder should simply try each codec in turn, in the order they were provided to the builder, until it finds one that succeeds.
Example:
1. abstract class Base case class SubclassA(name: String) extends Base case class SubclassB(x: Int, y: Int) extends Base implicit val aCodec = SimpleJsonCodecBuilder[SubclassA].build("name", _.name) implicit val bCodec = SimpleJsonCodecBuilder[SubclassB].build("x", _.x, "y", _.y) val baseCodec = SimpleHierarchyCodecBuilder[Base](NoTag). branch[SubclassA]. branch[SubclassB]. build println(baseCodec.encode(SubclassA("John"))) // { "name" : "John" } println(baseCodec.encode(SubclassB(1, 2))) // { "x" : 1, "y" : 2 }
See also
com.rojoma.json.v3.util.TagType
class NoTagSimpleHierarchyCodecBuilder[Root <: AnyRef] extends AnyRef
class NoTagSimpleHierarchyDecodeBuilder[Root <: AnyRef] extends AnyRef
class NoTagSimpleHierarchyEncodeBuilder[Root <: AnyRef] extends AnyRef
class NullForNone extends Annotation with Annotation with ClassfileAnnotation
class SimpleHierarchyCodecBuilder[Root <: AnyRef] extends AnyRef
class SimpleHierarchyDecodeBuilder[Root <: AnyRef] extends AnyRef
class SimpleHierarchyEncodeBuilder[Root <: AnyRef] extends AnyRef
final class Strategy extends Enum[Strategy]

case class TagAndValue(typeField: String, valueField: String) extends TagType with Product with Serializable

Specifies that the base codec should wrap the value generated by subclasses' com.rojoma.json.v3.codec.JsonEncodes and com.rojoma.json.v3.codec.JsonDecodes in another object containing two fields; one for the type-tag and one for the actual value.

Example:

abstract class Base
case class SubclassA(name: String) extends Base
case class SubclassB(x: Int, y: Int) extends Base
implicit val aCodec = SimpleJsonCodecBuilder[SubclassA].build("name", _.name)
implicit val bCodec = SimpleJsonCodecBuilder[SubclassB].build("x", _.x, "y", _.y)
val baseCodec = SimpleHierarchyCodecBuilder[Base](TagAndValue("type", "value")).
   branch[SubclassA]("a").
   branch[SubclassB]("b").
   build
println(baseCodec.encode(SubclassA("John"))) // { "type" : "a", "value" : { "name" : "John" } }
println(baseCodec.encode(SubclassB(1, 2))) // { "type" : "b", "value" : { "x" : 1, "y" : 2 } }

sealed abstract class TagType extends AnyRef

Specifies the mechanism for distinguishing among subclasses in a hierarchy with a tag.
Specifies the mechanism for distinguishing among subclasses in a hierarchy with a tag.

See also
com.rojoma.json.v3.util.NoTag
final class WrappedCharArray extends AnyRef

A container for a slice of an Array[Char] which promises to allow only read-only access to that array.
A container for a slice of an Array[Char] which promises to allow only read-only access to that array. Note it does not itself copy the array, so if there is another reference the data can be mutated by other operations.
class WrappedCharArrayIterator extends AbstractBufferedIterator[Char]

Value Members

object ArrayIteratorEncode

Converting iterators-of-jsonables to iterators that represent JArrays, without holding onto the contents of the iterator.
object AutomaticHierarchyCodecBuilder
object AutomaticHierarchyDecodeBuilder
object AutomaticHierarchyEncodeBuilder
object AutomaticJsonCodecBuilder
object AutomaticJsonDecodeBuilder
object AutomaticJsonEncodeBuilder
object JArrayProducer
object JValueProducer
object JsonArrayIterator

Helper for reading lazily reading objects out of a source of JsonEvents representing a JSON array.
Helper for reading lazily reading objects out of a source of JsonEvents representing a JSON array. Calling hasNext can throw any JsonLexException. Calling next() can throw any JSON lex or parse exception, or ElementDecodeException if the data in the array cannot be decoded as a T at that point. In the latter case, the iterator is still valid and positioned as if the decode had succeeded so it can continue to be used.
returns
An iterator of Ts

Exceptions thrown
JsonBadParse if alreadyInArray is false and the first event is not a StartOfArrayEvent
JsonLexException if alreadyInArray is false and a lexing exception or EOF occurs.
object JsonUtil
object NoTag extends NoTag with Product with Serializable
object SimpleHierarchyCodecBuilder
object SimpleHierarchyDecodeBuilder
object SimpleHierarchyEncodeBuilder
object SimpleJsonCodecBuilder

object TagToValue extends TagType with Product with Serializable

Specifies that the base codec should wrap the value generated by subclasses' com.rojoma.json.v3.codec.JsonEncodes and com.rojoma.json.v3.codec.JsonDecodes in another object containing a single field, which is the tag for that subclass.

Example:

abstract class Base
case class SubclassA(name: String) extends Base
case class SubclassB(x: Int, y: Int) extends Base
implicit val aCodec = SimpleJsonCodecBuilder[SubclassA].build("name", _.name)
implicit val bCodec = SimpleJsonCodecBuilder[SubclassB].build("x", _.x, "y", _.y)
val baseCodec = SimpleHierarchyCodecBuilder[Base](TagToValue).
   branch[SubclassA]("a").
   branch[SubclassB]("b").
   build
println(baseCodec.encode(SubclassA("John"))) // { "a" : { "name" : "John" } }
println(baseCodec.encode(SubclassB(1, 2))) // { "b" : { "x" : 1, "y" : 2 } }

object WrappedCharArray
object WrapperFieldCodec
object WrapperFieldDecode
object WrapperFieldEncode
object WrapperJsonCodec

Creates a combined com.rojoma.json.v3.codec.JsonEncode and com.rojoma.json.v3.codec.JsonDecode for a simple wrapper type.
Creates a combined com.rojoma.json.v3.codec.JsonEncode and com.rojoma.json.v3.codec.JsonDecode for a simple wrapper type. The wrap function may throw IllegalArgumentException; this is translated to a com.rojoma.json.v3.codec.DecodeError.InvalidValue.
object WrapperJsonDecode

Creates a com.rojoma.json.v3.codec.JsonDecode for a simple wrapper type.
Creates a com.rojoma.json.v3.codec.JsonDecode for a simple wrapper type. The wrap function may throw IllegalArgumentException; this is translated to a com.rojoma.json.v3.codec.DecodeError.InvalidValue.
object WrapperJsonEncode

Creates a com.rojoma.json.v3.codec.JsonEncode for a simple wrapper type.
package time

package util

Type Members

class AlternativeJsonKey extends Annotation with Annotation with ClassfileAnnotation

class AlternativeJsonKeys extends Annotation with Annotation with ClassfileAnnotation

macro class AutomaticJsonCodec extends Annotation with StaticAnnotation

macro class AutomaticJsonDecode extends Annotation with StaticAnnotation

macro class AutomaticJsonEncode extends Annotation with StaticAnnotation

case class InternalTag(fieldName: String, removeTagForSubcodec: Boolean = true) extends TagType with Product with Serializable

abstract class JArrayProducer extends AnyRef

final class JValueProducer extends AnyRef

class JsonCaseInsensitiveEnum extends Annotation with Annotation with ClassfileAnnotation

class JsonKey extends Annotation with Annotation with ClassfileAnnotation

class JsonKeyStrategy extends Annotation with Annotation with ClassfileAnnotation

class JsonTag extends Annotation with Annotation with ClassfileAnnotation

class LazyCodec extends Annotation with Annotation with ClassfileAnnotation

sealed abstract class NoTag extends AnyRef

class NoTagSimpleHierarchyCodecBuilder[Root <: AnyRef] extends AnyRef

class NoTagSimpleHierarchyDecodeBuilder[Root <: AnyRef] extends AnyRef

class NoTagSimpleHierarchyEncodeBuilder[Root <: AnyRef] extends AnyRef

class NullForNone extends Annotation with Annotation with ClassfileAnnotation

class SimpleHierarchyCodecBuilder[Root <: AnyRef] extends AnyRef

class SimpleHierarchyDecodeBuilder[Root <: AnyRef] extends AnyRef

class SimpleHierarchyEncodeBuilder[Root <: AnyRef] extends AnyRef

final class Strategy extends Enum[Strategy]

case class TagAndValue(typeField: String, valueField: String) extends TagType with Product with Serializable

sealed abstract class TagType extends AnyRef

final class WrappedCharArray extends AnyRef

class WrappedCharArrayIterator extends AbstractBufferedIterator[Char]

Value Members

object ArrayIteratorEncode

object AutomaticHierarchyCodecBuilder

object AutomaticHierarchyDecodeBuilder

object AutomaticHierarchyEncodeBuilder

object AutomaticJsonCodecBuilder

object AutomaticJsonDecodeBuilder

object AutomaticJsonEncodeBuilder

object JArrayProducer

object JValueProducer

object JsonArrayIterator

object JsonUtil

object NoTag extends NoTag with Product with Serializable

object SimpleHierarchyCodecBuilder

object SimpleHierarchyDecodeBuilder

object SimpleHierarchyEncodeBuilder

object SimpleJsonCodecBuilder

object TagToValue extends TagType with Product with Serializable

object WrappedCharArray

object WrapperFieldCodec

object WrapperFieldDecode

object WrapperFieldEncode

object WrapperJsonCodec

object WrapperJsonDecode

object WrapperJsonEncode

package time

Ungrouped