ProductHint

Abstract Value Members

abstract def bottom(cursor: ConfigObjectCursor, usedFields: Set[String]): Option[ConfigReaderFailures]

Returns optional failures given the provided ConfigObjectCursor.
Returns optional failures given the provided ConfigObjectCursor.
cursor
a ConfigObjectCursor at the configuration root from where the product was read
usedFields
a set of all the used fields when reading the product
returns
an optional non-empty list of failures.
abstract def from(cursor: ConfigObjectCursor, fieldName: String): Action

Returns what should be used when attempting to read a case class field with name fieldName from the provided ConfigObjectCursor.
Returns what should be used when attempting to read a case class field with name fieldName from the provided ConfigObjectCursor.
cursor
the cursor from which to read a value
fieldName
the name of the field in T
returns
a ProductHint.Action object that signals which cursor to use in order to read this field, the name of the corresponding field in the config object, whether the field should be removed from the object after read, and whether to use default values for this particular field.
abstract def to(value: Option[ConfigValue], fieldName: String): Option[(String, ConfigValue)]

Returns an optional key-value pair that should be used for the field with name fieldName in the ConfigObject representation of T.
Returns an optional key-value pair that should be used for the field with name fieldName in the ConfigObject representation of T.
value
the optional serialized value of the field
fieldName
the name of the field in T
returns
an optional key-value pair to be used in the ConfigObject representation of T. If None, the field is omitted from the ConfigObject representation.

Concrete 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 finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
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 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( ... )

Related Docs: object ProductHint | package generic

trait ProductHint[A] extends AnyRef

Abstract Value Members

abstract def bottom(cursor: ConfigObjectCursor, usedFields: Set[String]): Option[ConfigReaderFailures]

abstract def from(cursor: ConfigObjectCursor, fieldName: String): Action

abstract def to(value: Option[ConfigValue], fieldName: String): Option[(String, ConfigValue)]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped