class FieldCoproductHint[T] extends CoproductHint[T]
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.
- Alphabetic
- By Inheritance
- FieldCoproductHint
- CoproductHint
- AnyRef
- Any
- Hide All
- Show All
- 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[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
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[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
from(cur: ConfigCursor, name: String): Result[Option[ConfigCursor]]
Given a
ConfigValue
for the sealed family, disambiguate and extract theConfigValue
associated to the implementation for the given class or coproduct option name.Given a
ConfigValue
for the sealed family, disambiguate and extract theConfigValue
associated to the implementation for the given class or coproduct option name.If
cv
is a config for the given class name, this method returnsRight(Some(v))
, wherev
is the config related to the specific class (possibly the same ascv
). If it determines thatcv
is a config for a different class, it returnsRight(None)
. Ifcv
is missing information for disambiguation or has a wrong type, aLeft
containing aFailure
is returned.- cur
a
ConfigCursor
at the sealed family option- name
the name of the class or coproduct option to try
- returns
a
Either[ConfigReaderFailure, Option[ConfigValue]]
as defined above.
- Definition Classes
- FieldCoproductHint → CoproductHint
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
noOptionFound(cur: ConfigCursor): ConfigReaderFailures
Returns a non empty list of failures scoped into the context of a
ConfigCursor
, representing the failure to read an option from the config value.Returns a non empty list of failures scoped into the context of a
ConfigCursor
, representing the failure to read an option from the config value.- cur
a
ConfigCursor
at the sealed family option- returns
a non empty list of reader failures.
- Definition Classes
- FieldCoproductHint → CoproductHint
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
to(cv: ConfigValue, name: String): Result[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.- cv
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 aLeft
with the failure if some error occurred.
- Definition Classes
- FieldCoproductHint → CoproductHint
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
def
tryNextOnFail(name: String): Boolean
Defines what to do if
from
returnsSuccess(Some(_))
for a class or coproduct option, but itsConfigConvert
fails to deserialize the config.Defines what to do if
from
returnsSuccess(Some(_))
for a class or coproduct option, but itsConfigConvert
fails to deserialize the config.- name
the name of the class or coproduct option
- returns
true
if the next class or coproduct option should be tried,false
otherwise.
- Definition Classes
- FieldCoproductHint → CoproductHint
-
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( ... ) @native()