com.rojoma.json.matcher

PArray

case class PArray(subPatterns: Pattern*) extends Pattern with Product with Serializable

A com.rojoma.json.matcher.Pattern which matches if the value is a com.rojoma.json.ast.JArray which contains at least as many elements as sub-patterns contained by this object and those elements match the sub-patterns in the order given.

For the more common case where a sequence of repeated objects of a particular type is desired, use a com.rojoma.json.matcher.Variable of some Seq[T].

Linear Supertypes
Serializable, Serializable, Product, Equals, Pattern, OptPattern, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. PArray
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Pattern
  7. OptPattern
  8. AnyRef
  9. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PArray(subPatterns: Pattern*)

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

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

    Definition Classes
    Any
  7. def clone(): AnyRef

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

    Definition Classes
    AnyRef
  9. def evaluate(x: JValue, environment: Results): Option[Results]

    Tests the given com.rojoma.json.ast.JValue against this Pattern, with the restriction that any com.rojoma.json.matcher.Variables that are bound in the environment must match those values if they are re-used in this Pattern.

    Tests the given com.rojoma.json.ast.JValue against this Pattern, with the restriction that any com.rojoma.json.matcher.Variables that are bound in the environment must match those values if they are re-used in this Pattern.

    Generally you won't use this directly.

    x

    The value to test.

    returns

    The environment augmented with any new com.rojoma.json.matcher.Variables encountered in this Pattern, or None if it didn't match.

    Definition Classes
    PArrayPattern
  10. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. def generate(environment: Results): Option[JValue]

    Uses this Pattern together with the bindings generated as the result of a call to matches or evaluate to produce a com.rojoma.json.ast.JValue.

    Uses this Pattern together with the bindings generated as the result of a call to matches or evaluate to produce a com.rojoma.json.ast.JValue.

    Generally the other generate method is simpler to use.

    returns

    The new com.rojoma.json.ast.JValue, or None if a required com.rojoma.json.matcher.Variable is not bound in the environment, or a matcher which cannot generate is used.

    Definition Classes
    PArrayPattern
  12. def generate(bindings: (Results) ⇒ Results*): JValue

    Uses this Pattern together with the provided variable bindings to generate a new com.rojoma.json.ast.JValue.

    Uses this Pattern together with the provided variable bindings to generate a new com.rojoma.json.ast.JValue.

    returns

    The new com.rojoma.json.ast.JValue

    Definition Classes
    Pattern
    Example:
    1. val intVar = Variable[Int]
      val strVar = Variable[String]
      val pattern = PObject("i" -> intVar, "s" -> POption(strVar))
      
      pattern.generate(i := 1)                      // { "i" : 1 }
      pattern.generate(i := 1, s := "hello")        // { "i" : 1, "s" : "hello" }
      pattern.generate(i := 1, s :=? None )         // { "i" : 1 }
      pattern.generate(i := 1, s :=? Some("hello")) // { "i" : 1, "s" : "hello" }
    Exceptions thrown
    JsonGenerationException

    if a required com.rojoma.json.matcher.Variable is not bound or a matcher which cannot generate (such as com.rojoma.json.matcher.AllOf) is used.

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

    Definition Classes
    AnyRef → Any
  14. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  15. def matches(x: JValue): Option[Results]

    Tests the given com.rojoma.json.ast.JValue against this Pattern, and if it matches returns an object that can be used to retrieve the values matched by any com.rojoma.json.matcher.Variables in the Pattern.

    Tests the given com.rojoma.json.ast.JValue against this Pattern, and if it matches returns an object that can be used to retrieve the values matched by any com.rojoma.json.matcher.Variables in the Pattern.

    x

    The value to test.

    returns

    An environment which can be used to look up variable bindings, or None if it didn't match.

    Definition Classes
    Pattern
    Example:
    1. val intVar = Variable[Int]
      val strVar = Variable[String]
      val pattern = PObject("i" -> intVar, "s" -> strVar)
      
      pattern.matches(jvalue) match {
        case Some(results) => println("The integer was " + intVar(results))
        case None => println("It didn't match the pattern")
      }
  16. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  17. final def notify(): Unit

    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  19. val subPatterns: Pattern*

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

    Definition Classes
    AnyRef
  21. def unapply(x: JValue): Option[Results]

    Allows this Pattern to be used in a match expression, with the output being the environment of com.rojoma.json.matcher.Variable bindings as produced by matches.

    Allows this Pattern to be used in a match expression, with the output being the environment of com.rojoma.json.matcher.Variable bindings as produced by matches.

    Definition Classes
    Pattern
    Example:
    1. val intVar = Variable[Int]
      val strVar = Variable[String]
      val Pattern1 = PObject("i" -> intVar, "s" -> strVar)
      val Pattern2 = PObject("hello" -> "world")
      
      jvalue match {
        case Pattern1(results) => println("The integer was " + intVar(results))
        case Pattern2(result) => println("It was just a hello world object")
        case _ => println("It was something else")
      }
  22. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Pattern

Inherited from OptPattern

Inherited from AnyRef

Inherited from Any

Ungrouped