processor/com.sahsenvar.kmapper.processor.model/FieldInfo

FieldInfo

data class FieldInfo(val name: String, val type: KSType, val isNullable: Boolean, val hasDefault: Boolean, val isComputed: Boolean, val fieldMapTargets: Map<String, List<String>>, val isIgnored: Boolean, val convertWith: ConverterDirective? = null, val convertToDirective: ConverterDirective? = null, val convertFromDirective: ConverterDirective? = null, val validators: List<String> = emptyList(), val ignoreDefaultValue: Boolean = false)

Information about a field (constructor parameter or computed property) in a class.

Constructors

FieldInfo

constructor(name: String, type: KSType, isNullable: Boolean, hasDefault: Boolean, isComputed: Boolean, fieldMapTargets: Map<String, List<String>>, isIgnored: Boolean, convertWith: ConverterDirective? = null, convertToDirective: ConverterDirective? = null, convertFromDirective: ConverterDirective? = null, validators: List<String> = emptyList(), ignoreDefaultValue: Boolean = false)

Properties

convertFromDirective

val convertFromDirective: ConverterDirective?

Direction-scoped override from @ConvertFrom (reverse / @MapFrom direction); beats convertWith there.

convertToDirective

val convertToDirective: ConverterDirective?

Direction-scoped override from @ConvertTo (forward / @MapTo direction); beats convertWith there.

convertWith

val convertWith: ConverterDirective?

Bilateral per-field override from @ConvertWith (both directions).

fieldMapTargets

val fieldMapTargets: Map<String, List<String>>

Map of target class FQN to list of target field names (supports multiple @FieldMap per targetClass)

hasDefault

val hasDefault: Boolean

ignoreDefaultValue

val ignoreDefaultValue: Boolean

isComputed

val isComputed: Boolean

isIgnored

val isIgnored: Boolean

If true, this field will be ignored in automatic mapping (requires external parameter)

isNullable

val isNullable: Boolean

name

val name: String

type

val type: KSType

usesDefaultInMapping

val usesDefaultInMapping: Boolean

The only default flag mapping decisions may consult (omit/copy, external params).

validators

val validators: List<String>

FQNs of Validator objects from @Validate — fire whenever this field enters a mapping.

Functions

directiveFor

fun directiveFor(isReverse: Boolean): ConverterDirective?

This field's own directive for the requested direction (direction-scoped beats bilateral). Mapping decisions use effectiveDirective, which also decides WHICH side's field is asked.