FileData

data class FileData(declarationContainer: KmPackage, annotations: Collection<AnnotationSpec>, properties: Map<KmProperty, PropertyData>, methods: Map<KmFunction, MethodData>, className: ClassName, jvmName: String?) : ContainerData

Represents relevant information on a file facade used for ClassInspector.

Constructors

FileData
Link copied to clipboard
fun FileData(declarationContainer: KmPackage, annotations: Collection<AnnotationSpec>, properties: Map<KmProperty, PropertyData>, methods: Map<KmFunction, MethodData>, className: ClassName, jvmName: String? = if (!className.simpleName.endsWith("Kt")) className.simpleName else null)

Properties

annotations
Link copied to clipboard
open override val annotations: Collection<AnnotationSpec>

declared annotations on this class.

className
Link copied to clipboard
val className: ClassName

the KotlinPoet ClassName of the underlying facade class in JVM.

declarationContainer
Link copied to clipboard
open override val declarationContainer: KmPackage

the KmClass as parsed from the class's @Metadata annotation.

fileName
Link copied to clipboard
val fileName: String

The file name of the container, defaults to className's simple name + "Kt". If a jvmName is specified, it will always defer to that.

jvmName
Link copied to clipboard
val jvmName: String?

the @JvmName of the class or null if it does not have a custom name. Default will try to infer from the className.

methods
Link copied to clipboard
open override val methods: Map<KmFunction, MethodData>

the mapping of declarationContainer's methods to parsed MethodData.

properties
Link copied to clipboard
open override val properties: Map<KmProperty, PropertyData>

the mapping of declarationContainer's properties to parsed PropertyData.