advxml core/advxml.data

advxml.data

package advxml.data

Type members

Classlikes

trait AsValidable[V]
case class AttributeData(key: Key, value: SimpleValue)
Companion:
object
object AttributeData
Companion:
class
trait Converter[-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 parameters:
A

Contravariant input object type

B

Output object type

Companion:
object
object Converter
Companion:
class
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
object Predicate
case class SimpleValue(data: String, ref: Option[String]) extends Value with Comparable[SimpleValue]
Companion:
object
object SimpleValue
Companion:
class
object ThrowableNel
object ValidatedConverter
object ValidatedNelThrow
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
object 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]

type EitherNelThrow[+T] = EitherNel[Throwable, T]
type EitherThrow[+T] = Either[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 parameters:
A

Contravariant input object type

B

Output object type

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

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

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

Type parameters:
A

Contravariant input object type

B

Output object type

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

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

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

Type parameters:
T

Output object type

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

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

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

Type parameters:
T

Contravariant input object type

type XmlPredicate = NodeSeq => Boolean