kotlinx-metadata-jvm/kotlinx.metadata.jvm/KotlinClassMetadata/Companion

Companion

Collection of methods for reading and writing KotlinClassMetadata, as well as metadata kind constants and COMPATIBLE_METADATA_VERSION constant.

Properties

CLASS_KIND

const val CLASS_KIND: Int = 1

A class file kind signifying that the corresponding class file contains a declaration of a Kotlin class.

FILE_FACADE_KIND

const val FILE_FACADE_KIND: Int = 2

A class file kind signifying that the corresponding class file is a compiled Kotlin file facade.

MULTI_FILE_CLASS_FACADE_KIND

const val MULTI_FILE_CLASS_FACADE_KIND: Int = 4

A class file kind signifying that the corresponding class file is a compiled multi-file class facade.

MULTI_FILE_CLASS_PART_KIND

const val MULTI_FILE_CLASS_PART_KIND: Int = 5

A class file kind signifying that the corresponding class file is a compiled multi-file class part, i.e. an internal class with method bodies and their metadata, accessed only from the corresponding facade.

SYNTHETIC_CLASS_KIND

const val SYNTHETIC_CLASS_KIND: Int = 3

A class file kind signifying that the corresponding class file is synthetic, e.g. it is a class for lambda, $DefaultImpls class for interface method implementations, $WhenMappings class for optimized when over enums, etc.

Functions

readLenient

@JvmStatic

fun readLenient(annotationData: Metadata): KotlinClassMetadata

Reads and parses the given annotation data of a Kotlin JVM class file and returns the correct type of KotlinClassMetadata encoded by this annotation. KotlinClassMetadata instances obtained from this method cannot be written.

readStrict

@JvmStatic

fun readStrict(annotationData: Metadata): KotlinClassMetadata

Reads and parses the given annotation data of a Kotlin JVM class file and returns the correct type of KotlinClassMetadata encoded by this annotation, if the metadata version is supported.

transform

fun transform(metadata: Metadata, transformer: (KotlinClassMetadata) -> Unit): Metadata

Utility method to combine reading and writing of metadata: First, metadata is parsed with readStrict; then, transformer is called on a read instance. transformer may mutate passed instance of KotlinClassMetadata to achieve a desired result. After transformation, KotlinClassMetadata.write method is called and its result becomes return value of this method.