Class/Object

com.rayrobdod.json.builder

PiecewiseBuilder

Related Docs: object PiecewiseBuilder | package builder

Permalink

final class PiecewiseBuilder[Key, Value, Subject] extends Builder[Key, Value, Failures, Subject]

A Builder which can be built piecewise.

Key

the key types

Value

the primitive value types

Subject

the type of object to build

Source
PiecewiseBuilder.scala
Example:
  1. case class Foo(a:String, b:Seq[JsonValue], c:String)
    val fooBuilder = (new PiecewiseBuilder[StringOrInt, JsonValue, Foo](new Foo("", Seq.empty, ""))
    	.addDef(StringOrInt("a"), partitionedPrimitiveKeyDef({case JsonValueString(x) => Right(x)}, {(f:Foo, x:String) => f.copy(a = x)}))
    	.addDef(StringOrInt("c"), partitionedPrimitiveKeyDef({case JsonValueString(x) => Right(x)}, {(f:Foo, x:String) => f.copy(c = x)}))
    	.addDef(StringOrInt("b"), partitionedComplexKeyDef(new PrimitiveSeqBuilder[JsonValue], {(f:Foo, x:Seq[JsonValue]) => Right(f.copy(b = x))}))
    )
    val jsonParser = new JsonParser
    jsonParser.parse(fooBuilder, """{"a":"","b":[]}""")
    // results in `Foo("", Seq.empty, "")`
    jsonParser.parse(fooBuilder, """{"a":"qwer","b":["z","x","c"],"c":"asdf"}""")
    // results in `Foo("qwer", Seq(JsonValueString("z"), JsonValueString("x"),JsonValueString("c")), "asdf")`
Version

4.0

Since

3.0

See also

Inspired by https://github.com/scopt/scopt/

Linear Supertypes
Builder[Key, Value, Failures, Subject], AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PiecewiseBuilder
  2. Builder
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PiecewiseBuilder(init: Subject, defaultKeyDef: KeyDef[Key, Value, Subject] = ..., keyDefs: Map[Key, KeyDef[Key, Value, Subject]] = ...)

    Permalink

    init

    The starting point of the folding process

    defaultKeyDef

    the KeyDef executed when keyDefs does not contain a KeyDef for a specified key

    keyDefs

    the mapping of known keys to actual applies

Type Members

  1. type Middle = Subject

    Permalink

    The type of object while folding.

    The type of object while folding. If Builder weren't so whitebox, this would be a hidden implementation detail.

    Definition Classes
    PiecewiseBuilderBuilder
    Since

    4.0

Value Members

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. def addDef(key: Key, fun: KeyDef[Key, Value, Subject]): PiecewiseBuilder[Key, Value, Subject]

    Permalink

    add a KeyDef that will be used upon receiving the given key

  5. def apply[Input, PF, BE](folding: Subject, key: Key, input: Input, parser: Parser[Key, Value, PF, BE, Input], extra: BE): ParserRetVal[Subject, Nothing, PF, Failures, BE]

    Permalink

    Add a key-value pair to folding

    Add a key-value pair to folding

    The key is key, and the value is the result of com.rayrobdod.json.parser.Parser.parse on the provided input.

    folding

    the object to be added to. Must be either the return value of init or the return value of apply

    key

    the key of a key-value pair

    input

    the input to a parser

    parser

    a parser for turning input into a value

    returns

    either a built value or an error value

    Definition Classes
    PiecewiseBuilderBuilder
  6. final def asInstanceOf[T0]: T0

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

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

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. def finish[BE](extra: BE)(folding: Subject): Complex[Subject]

    Permalink

    A function to be called after the folding to produce a result

    A function to be called after the folding to produce a result

    Taking advantage of this method might be useful if either Middle is mutable for performance reasons and Result should be immutable or if the builder needs to use multiple key-value pairs fromt the source to produce some value in the domain object.

    If there is no need to take advantage of this, the implementation of this method can be

    override def finish[BFE](bfe:BFE)(x:Middle) = ParserRetVal.Complex(x)
    folding

    the object to be converted. Must be either the return value of init or the return value of apply

    returns

    either a built value or an error value

    Definition Classes
    PiecewiseBuilderBuilder
    Since

    4.0

  12. final def flatMapKey[K2, Err](fun: (K2) ⇒ Either[Err, Key]): Builder[K2, Value, Either[Err, Failures], Subject]

    Permalink

    Change the type of key that this builder requires, with the option of indicating an error condition

    Change the type of key that this builder requires, with the option of indicating an error condition

    fun

    a conversion function from the new key to this's key

    Definition Classes
    Builder
    Since

    3.1

  13. final def flatMapResult[R2, Err](fun: (Subject) ⇒ Either[Err, R2]): Builder[Key, Value, Either[Err, Failures], R2]

    Permalink

    Change the type of result produced by this builder, with the option of indicating an error condition

    Change the type of result produced by this builder, with the option of indicating an error condition

    Definition Classes
    Builder
    Since

    4.0

  14. final def flatMapValue[V2, Err](fun: (V2) ⇒ Either[Err, Value]): Builder[Key, V2, Either[Err, Failures], Subject]

    Permalink

    Change the type of value that this builder requires, with the option of indicating an error condition

    Change the type of value that this builder requires, with the option of indicating an error condition

    Definition Classes
    Builder
    Since

    3.0

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  17. def ignoreUnknownKeys: PiecewiseBuilder[Key, Value, Subject]

    Permalink

    Change the defaultKeyDef to one that will pass subject through

  18. val init: Subject

    Permalink

    The starting point of the folding process

    The starting point of the folding process

    Definition Classes
    PiecewiseBuilderBuilder
  19. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  20. final def mapFailure[F2](implicit fun: (Failures) ⇒ F2): Builder[Key, Value, F2, Subject]

    Permalink

    Change the type of failure produced by this builder

    Change the type of failure produced by this builder

    Definition Classes
    Builder
    Since

    4.0

  21. final def mapKey[K2](implicit fun: (K2) ⇒ Key): Builder[K2, Value, Failures, Subject]

    Permalink

    Change the type of key that this builder requires

    Change the type of key that this builder requires

    fun

    a conversion function from the new key to this's key

    Definition Classes
    Builder
    Since

    3.0

  22. final def mapResult[R2](implicit fun: (Subject) ⇒ R2): Builder[Key, Value, Failures, R2]

    Permalink

    Change the type of result produced by this builder

    Change the type of result produced by this builder

    Definition Classes
    Builder
    Since

    4.0

  23. final def mapValue[V2](implicit fun: (V2) ⇒ Value): Builder[Key, V2, Failures, Subject]

    Permalink

    Change the type of value that this builder requires

    Change the type of value that this builder requires

    fun

    a conversion function from the new value to this's value

    Definition Classes
    Builder
    Since

    3.0

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def zip[K2, V2, F2, R2](that: Builder[K2, V2, F2, R2])(implicit evk: <:<[K2, Key], evv: <:<[V2, Value], evf: <:<[Failures, F2]): Builder[K2, V2, F2, (Subject, R2)]

    Permalink

    Create a Builder which builds two items from the same input.

    Create a Builder which builds two items from the same input. The first item built being the one that this would build, and the second item built being the one that that would build.

    Most useful if the Parser input is neither stable nor resendable - say a network stream.

    that

    the other builder

    Definition Classes
    Builder
    Since

    3.1

Inherited from Builder[Key, Value, Failures, Subject]

Inherited from AnyRef

Inherited from Any

Ungrouped