advxml core/advxml.core.data

advxml.core.data

package advxml.core.data

Type members

Classlikes

trait AsValidable[V]
case class AttributeData(key: Key, value: SimpleValue)
Companion
object
object AttributeData
Companion
class
object Converter

Advxml Created by geirolad on 31/10/2019.

Advxml Created by geirolad on 31/10/2019.

final case class Key(value: String) extends AnyVal with Serializable
Companion
object
object Key
Companion
class
case class KeyValuePredicate(key: Key, valuePredicate: SimpleValue => Boolean)
object OptionConverter extends FixedBiConverterOps[[A] =>> Option[A], OptionConverter]
object Predicate
case class SimpleValue(data: String, ref: Option[String]) extends Value with Comparable[SimpleValue]
Companion
object
object SimpleValue extends SimpleValueLowPriorityInstances
Companion
class
object ThrowableNel
object ValidatedConverter extends FixedBiConverterOps[ValidatedNelEx, ValidatedConverter]
object ValidatedNelEx
case class ValidatedValue(data: String, rules: NonEmptyList[ValidationRule], ref: Option[String]) extends Value
Companion
object
object ValidatedValue
Companion
class
class ValidationRule(val name: String, val validator: String => Boolean, val errorReason: String)
Companion
object
object ValidationRule
Companion
class
sealed trait Value extends AsValidable[ValidatedValue]
Companion
object
object Value
Companion
class
trait ValueExtractor[F[_], V <: Value]
Companion
object
object ValueExtractor
Companion
class
object XmlDecoder extends FixedLeftConverterOps[ValidatedNelEx, NodeSeq, XmlDecoder]
object XmlEncoder extends FixedRightConverterOps[ValidatedNelEx, NodeSeq, XmlEncoder]
object XmlPredicate

Types

@implicitNotFound("Missing implicit Converter instance to covert ${A} into ${B}")
type As[-A, B] = Converter[A, B]

Syntactic sugar. To use ase A As B instead of classic method Converter[A, B]

Syntactic sugar. To use ase A As B instead of classic method Converter[A, B]

@implicitNotFound("Missing implicit Converter instance to covert ${A} into ${B}")
type Converter[-A, B] = Kleisli[Id, A, B]

Represents a function A => B to simplify method and class signatures. This alias represent a converter to transform A into B.

Represents a function A => B to simplify method and class signatures. This alias represent a converter to transform A into B.

Type Params
A

Contravariant input object type

B

Output object type

type EitherEx[+T] = Either[Throwable, T]
type EitherNelEx[+T] = EitherNel[Throwable, T]
@implicitNotFound("Missing implicit OptionConverter instance to covert ${A} into Option[${B}].")
type OptionConverter[-A, B] = Converter[A, Option[B]]

Represents a function A => Option[B] to simplify method and class signatures. Because the conversion can fail the output is wrapped into Option in order to handle the empty case.

Represents a function A => Option[B] to simplify method and class signatures. Because the conversion can fail the output is wrapped into Option in order to handle the empty case.

Type Params
A

Contravariant input object type

B

Output object type

type ThrowableNel = NonEmptyList[Throwable]
@implicitNotFound("Missing implicit ValidatedConverter instance to covert ${A} into ValidatedNelEx[${B}]")
type ValidatedConverter[-A, B] = Converter[A, ValidatedNelEx[B]]

Represents a function A => ValidatedEx[B] to simplify method and class signatures. Because the conversion can fail the output is wrapped into cats ValidatedNelEx in order to handle the errors.

Represents a function A => ValidatedEx[B] to simplify method and class signatures. Because the conversion can fail the output is wrapped into cats ValidatedNelEx in order to handle the errors.

Type Params
A

Contravariant input object type

B

Output object type

type ValidatedEx[+T] = Validated[Throwable, T]
type ValidatedNelEx[+T] = ValidatedNel[Throwable, T]
@implicitNotFound("Missing implicit XmlDecoder instance to covert NodeSeq into ValidatedNelEx[${T}].")
type XmlDecoder[T] = ValidatedConverter[NodeSeq, T]

This is just an alias for advxml.core.data.ValidatedConverter parametrized with NodeSeq on left side.

This is just an alias for advxml.core.data.ValidatedConverter parametrized with NodeSeq on left side.

Type Params
T

Output object type

@implicitNotFound("Missing implicit XmlDecoder instance to covert ${T} into ValidatedNelEx[NodeSeq].")
type XmlEncoder[T] = ValidatedConverter[T, NodeSeq]

This is just an alias for advxml.core.data.ValidatedConverter parametrized with NodeSeq on right side.

This is just an alias for advxml.core.data.ValidatedConverter parametrized with NodeSeq on right side.

Type Params
T

Contravariant input object type

type XmlPredicate = NodeSeq => Boolean