Packages

object DynamoFormat extends EnumDynamoFormat with Serializable

Linear Supertypes
Serializable, Serializable, EnumDynamoFormat, DerivedDynamoFormat, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DynamoFormat
  2. Serializable
  3. Serializable
  4. EnumDynamoFormat
  5. DerivedDynamoFormat
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. trait CoProductDynamoFormat[T] extends DynamoFormat[T]
    Definition Classes
    DerivedDynamoFormat
  2. trait ConstructedDynamoFormat[T] extends AnyRef
    Definition Classes
    DerivedDynamoFormat
  3. trait InvalidConstructedDynamoFormat[T] extends ConstructedDynamoFormat[T]
    Definition Classes
    DerivedDynamoFormat
  4. trait ValidConstructedDynamoFormat[T] extends ConstructedDynamoFormat[T]
    Definition Classes
    DerivedDynamoFormat
  5. trait AllOps[T] extends Ops[T]
  6. type NotSymbol[T] = <:!<[T, Symbol]
    Definition Classes
    DerivedDynamoFormat
  7. trait Ops[T] extends AnyRef
  8. trait ToDynamoFormatOps extends AnyRef
  9. type ValidatedPropertiesError[T] = Validated[InvalidPropertiesError, T]
    Definition Classes
    DerivedDynamoFormat

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. implicit val BigDecimalSetFormat: DynamoFormat[Set[BigDecimal]] 

    prop> import com.amazonaws.services.dynamodbv2.model.AttributeValue
prop> import org.scalacheck._
prop> implicit def arbNonEmptySet[T: Arbitrary] = Arbitrary(Gen.nonEmptyContainerOf[Set, T](Arbitrary.arbitrary[T]))

prop> (s: Set[BigDecimal]) =>
    | val av = new AttributeValue().withNS(s.toList.map(_.toString): _*)
    | DynamoFormat[Set[BigDecimal]].write(s) == av &&
    |   DynamoFormat[Set[BigDecimal]].read(av) == Right(s)

>>> DynamoFormat[Set[BigDecimal]].write(Set.empty).getNULL
true
  5. def apply[T](implicit instance: DynamoFormat[T]): DynamoFormat[T]
    Annotations
    @inline()
  6. implicit def arrayFormat[T](implicit arg0: ClassTag[T], f: DynamoFormat[T]): DynamoFormat[Array[T]] 

    prop> (a: Array[String]) =>
    | DynamoFormat[Array[String]].read(DynamoFormat[Array[String]].write(a)).right.getOrElse(Array("error")).deep ==
    |   a.deep
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. implicit val bigDecimalFormat: DynamoFormat[BigDecimal] 

    prop> (d: BigDecimal) =>
    | DynamoFormat[BigDecimal].read(DynamoFormat[BigDecimal].write(d)) == Right(d)
  9. implicit val booleanFormat: DynamoFormat[Boolean] 

    prop> (b: Boolean) =>
    | DynamoFormat[Boolean].read(DynamoFormat[Boolean].write(b)) == Right(b)
  10. implicit val byteArrayFormat: DynamoFormat[Array[Byte]] 

    prop> (ab:Array[Byte]) =>
    | DynamoFormat[Array[Byte]].read(DynamoFormat[Array[Byte]].write(ab)) == Right(ab)
  11. implicit val byteFormat: DynamoFormat[Byte] 

    prop> (b: Byte) =>
    | DynamoFormat[Byte].read(DynamoFormat[Byte].write(b)) == Right(b)
  12. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  13. implicit val cnil: CoProductDynamoFormat[CNil]
    Definition Classes
    DerivedDynamoFormat
  14. def coercedXmap[A, B, T >: Null <: Throwable](read: (B) ⇒ A)(write: (A) ⇒ B)(implicit f: DynamoFormat[B], T: ClassTag[T], NT: NotNull[T]): DynamoFormat[A]

    Returns a DynamoFormat for the case where A can always be converted B, with write, but read may throw an exception for some value of B

    Returns a DynamoFormat for the case where A can always be converted B, with write, but read may throw an exception for some value of B

    >>> import org.joda.time._

>>> val jodaStringFormat = DynamoFormat.coercedXmap[LocalDate, String, IllegalArgumentException](
...   LocalDate.parse
... )(
...   _.toString
... )
>>> jodaStringFormat.read(jodaStringFormat.write(new LocalDate(2007, 8, 18)))
Right(2007-08-18)

>>> import com.amazonaws.services.dynamodbv2.model.AttributeValue
>>> jodaStringFormat.read(new AttributeValue().withS("Togtogdenoggleplop"))
Left(TypeCoercionError(java.lang.IllegalArgumentException: Invalid format: "Togtogdenoggleplop"))
  15. implicit def coproduct[K <: Symbol, V, T <: Coproduct](implicit headFormat: Lazy[DynamoFormat[V]], tailFormat: CoProductDynamoFormat[T], fieldWitness: Aux[K]): CoProductDynamoFormat[:+:[FieldType[K, V], T]]
    Definition Classes
    DerivedDynamoFormat
  16. implicit val doubleFormat: DynamoFormat[Double] 

    prop> (d: Double) =>
    | DynamoFormat[Double].read(DynamoFormat[Double].write(d)) == Right(d)
  17. implicit val doubleSetFormat: DynamoFormat[Set[Double]] 

    prop> import com.amazonaws.services.dynamodbv2.model.AttributeValue
prop> import org.scalacheck._
prop> implicit def arbNonEmptySet[T: Arbitrary] = Arbitrary(Gen.nonEmptyContainerOf[Set, T](Arbitrary.arbitrary[T]))

prop> (s: Set[Double]) =>
    | val av = new AttributeValue().withNS(s.toList.map(_.toString): _*)
    | DynamoFormat[Set[Double]].write(s) == av &&
    |   DynamoFormat[Set[Double]].read(av) == Right(s)

>>> DynamoFormat[Set[Double]].write(Set.empty).getNULL
true
  18. implicit def enumDynamoFormatCCons[K <: Symbol, V, R <: Coproduct](implicit fieldWitness: Aux[K], emptyGeneric: Aux[V, HNil], alternativeFormat: EnumerationDynamoFormat[R]): EnumerationDynamoFormat[:+:[FieldType[K, V], R]]
    Definition Classes
    EnumDynamoFormat
  19. implicit val enumDynamoFormatCNil: EnumerationDynamoFormat[CNil]
    Definition Classes
    EnumDynamoFormat
  20. implicit def enumFormat[A, Repr <: Coproduct](implicit gen: Aux[A, Repr], genericFormat: EnumerationDynamoFormat[Repr]): EnumerationDynamoFormat[A]
    Definition Classes
    EnumDynamoFormat
  21. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  23. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  24. implicit def genericCoProduct[T, R](implicit gen: Aux[T, R], formatR: Lazy[CoProductDynamoFormat[R]]): DynamoFormat[T]
    Definition Classes
    DerivedDynamoFormat
  25. implicit def genericProduct[T, R](implicit arg0: NotSymbol[T], gen: Aux[T, R], formatR: Lazy[ValidConstructedDynamoFormat[R]]): DynamoFormat[T]
    Definition Classes
    DerivedDynamoFormat
  26. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  27. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  28. implicit def hcons[K <: Symbol, V, T <: HList](implicit headFormat: Lazy[DynamoFormat[V]], tailFormat: Lazy[ConstructedDynamoFormat[T]], fieldWitness: Aux[K]): ValidConstructedDynamoFormat[::[FieldType[K, V], T]]
    Definition Classes
    DerivedDynamoFormat
  29. implicit val hnil: InvalidConstructedDynamoFormat[HNil]
    Definition Classes
    DerivedDynamoFormat
  30. implicit val intFormat: DynamoFormat[Int] 

    prop> (i: Int) =>
    | DynamoFormat[Int].read(DynamoFormat[Int].write(i)) == Right(i)
  31. implicit val intSetFormat: DynamoFormat[Set[Int]] 

    prop> import com.amazonaws.services.dynamodbv2.model.AttributeValue
prop> import org.scalacheck._
prop> implicit def arbNonEmptySet[T: Arbitrary] = Arbitrary(Gen.nonEmptyContainerOf[Set, T](Arbitrary.arbitrary[T]))

prop> (s: Set[Int]) =>
    | val av = new AttributeValue().withNS(s.toList.map(_.toString): _*)
    | DynamoFormat[Set[Int]].write(s) == av &&
    |   DynamoFormat[Set[Int]].read(av) == Right(s)

>>> DynamoFormat[Set[Int]].write(Set.empty).getNULL
true
  32. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  33. def iso[A, B](r: (B) ⇒ A)(w: (A) ⇒ B)(implicit f: DynamoFormat[B]): DynamoFormat[A] { val default: Option[A] }

    Returns a DynamoFormat for the case where A and B are isomorphic, i.e.

    Returns a DynamoFormat for the case where A and B are isomorphic, i.e. an A can always be converted to a B and vice versa.

    If there are some values of B that have no corresponding value in A, use DynamoFormat.xmap or DynamoFormat.coercedXmap.

    >>> import com.amazonaws.services.dynamodbv2.model.AttributeValue

>>> case class UserId(value: String)

>>> implicit val userIdFormat =
...   DynamoFormat.iso[UserId, String](UserId.apply)(_.value)
>>> DynamoFormat[UserId].read(new AttributeValue().withS("Eric"))
Right(UserId(Eric))
  34. val javaListFormat: DynamoFormat[List[AttributeValue]]
  35. implicit def listFormat[T](implicit f: DynamoFormat[T]): DynamoFormat[List[T]] 

    prop> (l: List[String]) =>
    | DynamoFormat[List[String]].read(DynamoFormat[List[String]].write(l)) ==
    |   Right(l)
  36. implicit val longFormat: DynamoFormat[Long] 

    prop> (l: Long) =>
    | DynamoFormat[Long].read(DynamoFormat[Long].write(l)) == Right(l)
  37. implicit val longSetFormat: DynamoFormat[Set[Long]] 

    prop> import com.amazonaws.services.dynamodbv2.model.AttributeValue
prop> import org.scalacheck._
prop> implicit def arbNonEmptySet[T: Arbitrary] = Arbitrary(Gen.nonEmptyContainerOf[Set, T](Arbitrary.arbitrary[T]))

prop> (s: Set[Long]) =>
    | val av = new AttributeValue().withNS(s.toList.map(_.toString): _*)
    | DynamoFormat[Set[Long]].write(s) == av &&
    |   DynamoFormat[Set[Long]].read(av) == Right(s)

>>> DynamoFormat[Set[Long]].write(Set.empty).getNULL
true
  38. implicit def mapFormat[V](implicit f: DynamoFormat[V]): DynamoFormat[Map[String, V]] 

    prop> (m: Map[String, Int]) =>
    | DynamoFormat[Map[String, Int]].read(DynamoFormat[Map[String, Int]].write(m)) ==
    |   Right(m)
  39. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  40. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  41. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  42. implicit def optionFormat[T](implicit f: DynamoFormat[T]): DynamoFormat[Option[T]] { val default: Some[None.type] } 

    prop> (o: Option[Long]) =>
    | DynamoFormat[Option[Long]].read(DynamoFormat[Option[Long]].write(o)) ==
    |   Right(o)

>>> DynamoFormat[Option[Long]].read(new com.amazonaws.services.dynamodbv2.model.AttributeValue().withNULL(true))
Right(None)
  43. implicit def seqFormat[T](implicit f: DynamoFormat[T]): DynamoFormat[Seq[T]] 

    prop> (sq: Seq[String]) =>
    | DynamoFormat[Seq[String]].read(DynamoFormat[Seq[String]].write(sq)) ==
    |   Right(sq)
  44. implicit val shortFormat: DynamoFormat[Short] 

    prop> (s: Short) =>
    | DynamoFormat[Short].read(DynamoFormat[Short].write(s)) == Right(s)
  45. implicit def someFormat[T](implicit f: DynamoFormat[T]): DynamoFormat[Some[T]]

    This ensures that if, for instance, you specify an update with Some(5) rather than making the type of Option explicit, it doesn't fall back to auto-derivation

  46. implicit val stringFormat: DynamoFormat[String] 

    prop> (s: String) =>
    | DynamoFormat[String].read(DynamoFormat[String].write(s)) == Right(s)
  47. implicit val stringSetFormat: DynamoFormat[Set[String]] 

    prop> import com.amazonaws.services.dynamodbv2.model.AttributeValue
prop> import org.scalacheck._
prop> implicit val arbSet = Arbitrary(Gen.nonEmptyContainerOf[Set, String](Arbitrary.arbitrary[String]))

prop> (s: Set[String]) =>
    | val av = new AttributeValue().withSS(s.toList: _*)
    | DynamoFormat[Set[String]].write(s) == av &&
    |   DynamoFormat[Set[String]].read(av) == Right(s)

>>> DynamoFormat[Set[String]].write(Set.empty).getNULL
true
  48. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  49. def toString(): String
    Definition Classes
    AnyRef → Any
  50. implicit val uuidFormat: DynamoFormat[UUID] 

    prop> implicit val arbitraryUUID = org.scalacheck.Arbitrary(org.scalacheck.Gen.uuid)
prop> (uuid: java.util.UUID) =>
    | DynamoFormat[java.util.UUID].read(DynamoFormat[java.util.UUID].write(uuid)) ==
    |   Right(uuid)
  51. implicit def vectorFormat[T](implicit f: DynamoFormat[T]): DynamoFormat[Vector[T]] 

    prop> (v: Vector[String]) =>
    | DynamoFormat[Vector[String]].read(DynamoFormat[Vector[String]].write(v)) ==
    |   Right(v)
  52. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  53. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  54. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  55. def xmap[A, B](r: (B) ⇒ Either[DynamoReadError, A])(w: (A) ⇒ B)(implicit f: DynamoFormat[B]): DynamoFormat[A] 

    >>> import org.joda.time._
>>> import com.amazonaws.services.dynamodbv2.model.AttributeValue

>>> implicit val jodaLongFormat = DynamoFormat.xmap[DateTime, Long](
...   l => Right(new DateTime(l).withZone(DateTimeZone.UTC))
... )(
...   _.withZone(DateTimeZone.UTC).getMillis
... )
>>> DynamoFormat[DateTime].read(new AttributeValue().withN("0"))
Right(1970-01-01T00:00:00.000Z)
  56. object nonInheritedOps extends ToDynamoFormatOps
  57. object ops

Inherited from Serializable

Inherited from Serializable

Inherited from EnumDynamoFormat

Inherited from DerivedDynamoFormat

Inherited from AnyRef

Inherited from Any

Ungrouped