processor/com.sahsenvar.kmapper.processor.analyzer/CollectionWrapperDescriptor

CollectionWrapperDescriptor

data class CollectionWrapperDescriptor(val wrapperObjectFqn: String, val forTypeFqn: String, val providesWrap: Boolean, val providesUnwrap: Boolean)

A validated @CollectionWrapper registration: which container type it serves and which directions it provides. TypeMatcher consults the direction flags so a mapping that needs a missing direction gets a guided compile error (the wrapper counterpart of UnsupportedConversion).

Constructors

CollectionWrapperDescriptor

constructor(wrapperObjectFqn: String, forTypeFqn: String, providesWrap: Boolean, providesUnwrap: Boolean)

Properties

val forTypeFqn: String

FQN of the wrapped container type from @CollectionWrapper.forType.

forTypeSimpleName

val forTypeSimpleName: String

Simple name of the wrapped container type for error messages.

val providesUnwrap: Boolean

True when a valid fun <T> unwrap(source: ForType<T>): List<T> is declared.

val providesWrap: Boolean

True when a valid fun <T> wrap(source: List<T>): ForType<T> is declared.

wrapperObjectFqn

val wrapperObjectFqn: String

FQN of the wrapper object (e.g. com.example.PersistentListWrapper).

wrapperSimpleName

val wrapperSimpleName: String

Simple name of the wrapper object for error messages.