object ConfigBeanFactory
Factory for automatically creating a Java class from a Config. See ConfigBeanFactory.create(Config,Class).
- Since
1.3.0
- Alphabetic
- By Inheritance
- ConfigBeanFactory
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
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
- @native() @throws( ... )
-
def
create[T](config: Config, clazz: Class[T]): T
Creates an instance of a class, initializing its fields from a Config.
Creates an instance of a class, initializing its fields from a Config.
Example usage:
val configSource: Config = ConfigFactory.load().getConfig("foo"); val config: FooConfig = ConfigBeanFactory.create(configSource, classOf[FooConfig]);
The Java class should follow JavaBean conventions. Field types can be any of the types you can normally get from a Config, including
java.time.Duration
or ConfigMemorySize. Fields may also be another JavaBean-style class.Fields are mapped to config by converting the config key to camel case. So the key
foo-bar
becomes JavaBean settersetFooBar
.- config
source of config information
- clazz
class to be instantiated
- returns
an instance of the class populated with data from the config
- Since
1.3.0
- Exceptions thrown
ConfigException
Can throw the same exceptions as the getters onConfig
[[ConfigException#BadBean]]
If something is wrong with the JavaBean[[ConfigException#ValidationFailed]]
If the config doesn't conform to the bean's implied schema
-
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
- 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
-
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
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
- @native() @throws( ... )