Class

pureconfig

FirstSuccessCoproductHint

Related Doc: package pureconfig

Permalink

class FirstSuccessCoproductHint[T] extends CoproductHint[T]

Hint where all coproduct options are tried in order. from will choose the first option able to deserialize the config without errors, while to will write the config as is, with no disambiguation information.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FirstSuccessCoproductHint
  2. CoproductHint
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FirstSuccessCoproductHint()

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

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

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

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

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

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

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. def from(cur: ConfigCursor, name: String): Right[Nothing, Some[ConfigCursor]]

    Permalink

    Given a ConfigValue for the sealed family, disambiguate and extract the ConfigValue associated to the implementation for the given class or coproduct option name.

    Given a ConfigValue for the sealed family, disambiguate and extract the ConfigValue associated to the implementation for the given class or coproduct option name.

    If cv is a config for the given class name, this method returns Right(Some(v)), where v is the config related to the specific class (possibly the same as cv). If it determines that cv is a config for a different class, it returns Right(None). If cv is missing information for disambiguation or has a wrong type, a Left containing a Failure 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
    FirstSuccessCoproductHintCoproductHint
  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int

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

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

    Permalink
    Definition Classes
    AnyRef
  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. final def notifyAll(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  17. def to(cv: ConfigValue, name: String): Right[Nothing, ConfigValue]

    Permalink

    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 a Left with the failure if some error occurred.

    Definition Classes
    FirstSuccessCoproductHintCoproductHint
  18. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  19. def tryNextOnFail(name: String): Boolean

    Permalink

    Defines what to do if from returns Success(Some(_)) for a class or coproduct option, but its ConfigConvert fails to deserialize the config.

    Defines what to do if from returns Success(Some(_)) for a class or coproduct option, but its ConfigConvert 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
    FirstSuccessCoproductHintCoproductHint
  20. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from CoproductHint[T]

Inherited from AnyRef

Inherited from Any

Ungrouped