Embabel Agent Documentation/com.embabel.agent.core/JvmType

JvmType

data class JvmType constructor(val className: String) : DomainType

Typed backed by a JVM object It's good practice to annotate classes with @JsonClassDescription for better descriptions: otherwise, only the simple class name will be used. Use the @CreationPermitted annotation to indicate whether new instances of this type can be created. Default is true.

Constructors

JvmType

constructor(clazz: Class<*>)

constructor(className: String)

Types

Companion

object Companion

Properties

className

val className: String

clazz

val clazz: Class<*>

creationPermitted

open override val creationPermitted: Boolean

Is instance creation permitted? Or is this reference data?

description

open val description: String

labels

open val labels: Set<String>

Get all labels for this type, including from parent types. For JvmType: simple class names of this type and all parent types. For DynamicType: capitalized value after last '.' in name, plus parent labels.

name

open val name: String

ownLabel

open override val ownLabel: String

Get the label for this type only (not including parent labels) This will avoid long FQNs which are not useful for labeling.

ownProperties

open override val ownProperties: List<PropertyDefinition>

Properties defined on this type only (not inherited)

parents

open override val parents: List<JvmType>

Supports inheritance

properties

open val properties: List<PropertyDefinition>

Get all properties, including inherited ones. Exposed even for JvmTypes, for consistency. Properties are deduplicated by name, with own properties taking precedence over inherited ones.

relationships

open val relationships: List<DomainTypePropertyDefinition>

All relationship properties defined on this type and inherited ones

values

open val values: List<ValuePropertyDefinition>

Value properties defined on this type and inherited ones

Functions

children

open override fun children(additionalBasePackages: Collection<String>): Collection<JvmType>

Get all descendant types from the classpath. For JvmType: scans the classpath for classes that extend or implement this type. For DynamicType: returns empty list as dynamic types don't have classpath descendants.

infoString

open fun infoString(verbose: Boolean?, indent: Int): String

isAssignableFrom

open override fun isAssignableFrom(other: DomainType): Boolean

open override fun isAssignableFrom(other: Class<*>): Boolean

isAssignableTo

open override fun isAssignableTo(other: DomainType): Boolean

open override fun isAssignableTo(other: Class<*>): Boolean