Class/Object

pureconfig.generic

FieldCoproductHint

Related Docs: object FieldCoproductHint | package generic

Permalink

class FieldCoproductHint[A] extends CoproductHint[A]

Hint where the options are disambiguated by a key = "value" field inside the config.

This hint will cause derived ConfigConvert instance to fail to convert configs to objects if the object has a field with the same name as the disambiguation key.

By default, the field value written is the class or coproduct option name converted to kebab case. This mapping can be changed by overriding the method fieldValue of this class.

Linear Supertypes

CoproductHint[A], AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

FieldCoproductHint
CoproductHint
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Instance Constructors

new FieldCoproductHint(key: String)

Value Members

final def !=(arg0: Any): Boolean

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

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

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def fieldValue(name: String): String

Returns the field value for a class or coproduct option name.
Returns the field value for a class or coproduct option name.
name
the name of the class or coproduct option
returns
the field value associated with the given class or coproduct option name.

Attributes
protected
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def from(cursor: ConfigCursor, options: Seq[String]): Result[Action]

Given a ConfigCursor for the sealed family, disambiguate and return what should be performed when trying to read one of the provided coproduct options.
Given a ConfigCursor for the sealed family, disambiguate and return what should be performed when trying to read one of the provided coproduct options. This method can decide either to:
- use the ConfigCursor with a single option (CoproductHint.Use);
- or attempt different options in a given order (CoproductHint.Attempt).
This method can return a Left if the hint fails to produce a valid CoproductHint.Action.
cursor
a ConfigCursor at the sealed family option
options
the names of the coproduct options for the given type
returns
a ConfigReader.Result of CoproductHint.Action as defined above.

Definition Classes
FieldCoproductHint → CoproductHint
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

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

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

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

Definition Classes
AnyRef
def to(value: ConfigValue, name: String): ConfigValue

Given the ConfigValue for a specific class or coproduct option, encode disambiguation information and return a config for the sealed family or coproduct.
Given the ConfigValue for a specific class or coproduct option, encode disambiguation information and return a config for the sealed family or coproduct.
value
the ConfigValue of the class or coproduct option
name
the name of the class or coproduct option
returns
the config for the sealed family or coproduct wrapped in a Right, or a Left with the failure if some error occurred.

Definition Classes
FieldCoproductHint → CoproductHint
def toString(): String

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

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Inherited from CoproductHint[A]

Inherited from AnyRef

Inherited from Any

Ungrouped