Package com.squareup.kotlinpoet.metadata

Types

ImmutableKmClass

data class ImmutableKmClass : ImmutableKmDeclarationContainer, ImmutableKmWithFlags

Immutable representation of KmClass.

ImmutableKmConstructor

data class ImmutableKmConstructor : ImmutableKmWithFlags

Immutable representation of KmConstructor.

ImmutableKmContract

data class ImmutableKmContract

Immutable representation of KmContract.

ImmutableKmDeclarationContainer

interface ImmutableKmDeclarationContainer

Immutable representation of KmDeclarationContainer.

ImmutableKmEffect

data class ImmutableKmEffect

Immutable representation of KmEffect.

ImmutableKmEffectExpression

data class ImmutableKmEffectExpression : ImmutableKmWithFlags

Immutable representation of KmEffectExpression.

ImmutableKmFlexibleTypeUpperBound

data class ImmutableKmFlexibleTypeUpperBound

Immutable representation of KmFlexibleTypeUpperBound.

ImmutableKmFunction

data class ImmutableKmFunction : ImmutableKmWithFlags

Immutable representation of KmFunction.

ImmutableKmLambda

data class ImmutableKmLambda

Immutable representation of KmLambda.

ImmutableKmPackage

data class ImmutableKmPackage : ImmutableKmDeclarationContainer

Immutable representation of KmPackage.

ImmutableKmProperty

data class ImmutableKmProperty : ImmutableKmWithFlags

Immutable representation of KmProperty.

ImmutableKmType

data class ImmutableKmType : ImmutableKmWithFlags

Immutable representation of KmType.

ImmutableKmTypeAlias

data class ImmutableKmTypeAlias : ImmutableKmWithFlags

Immutable representation of KmTypeAlias.

ImmutableKmTypeParameter

data class ImmutableKmTypeParameter : ImmutableKmWithFlags

Immutable representation of KmTypeParameter.

ImmutableKmTypeProjection

data class ImmutableKmTypeProjection

Immutable representation of KmTypeProjection.

ImmutableKmValueParameter

data class ImmutableKmValueParameter : ImmutableKmWithFlags

Immutable representation of KmValueParameter.

ImmutableKmVersionRequirement

data class ImmutableKmVersionRequirement : KmVersionRequirementVisitor

Immutable representation of KmVersionRequirement.

ImmutableKmWithFlags

interface ImmutableKmWithFlags

Represents an immutable kotlinx-metadata type with a common Flags property.

KotlinPoetMetadataPreview

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY])

annotation class KotlinPoetMetadataPreview

Indicates that a given API is part of the experimental KotlinPoet metadata support.

PropertyAccessorFlag

enum PropertyAccessorFlag : Enum<PropertyAccessorFlag>

Functions

readKotlinClassMetadata

fun Metadata.readKotlinClassMetadata(): KotlinClassMetadata

Returns the KotlinClassMetadata this represents.

toImmutable

@JvmName(name = "immutableOf")

fun KmClass.toImmutable(): ImmutableKmClass

@JvmName(name = "immutableOf")

fun KmConstructor.toImmutable(): ImmutableKmConstructor

@JvmName(name = "immutableOf")

fun KmContract.toImmutable(): ImmutableKmContract

@JvmName(name = "immutableOf")

fun KmEffect.toImmutable(): ImmutableKmEffect

@JvmName(name = "immutableOf")

fun KmEffectExpression.toImmutable(): ImmutableKmEffectExpression

@JvmName(name = "immutableOf")

fun KmFlexibleTypeUpperBound.toImmutable(): ImmutableKmFlexibleTypeUpperBound

@JvmName(name = "immutableOf")

fun KmFunction.toImmutable(): ImmutableKmFunction

@JvmName(name = "immutableOf")

fun KmLambda.toImmutable(): ImmutableKmLambda

@JvmName(name = "immutableOf")

fun KmPackage.toImmutable(): ImmutableKmPackage

@JvmName(name = "immutableOf")

fun KmProperty.toImmutable(): ImmutableKmProperty

@JvmName(name = "immutableOf")

fun KmType.toImmutable(): ImmutableKmType

@JvmName(name = "immutableOf")

fun KmTypeAlias.toImmutable(): ImmutableKmTypeAlias

@JvmName(name = "immutableOf")

fun KmTypeParameter.toImmutable(): ImmutableKmTypeParameter

@JvmName(name = "immutableOf")

fun KmTypeProjection.toImmutable(): ImmutableKmTypeProjection

@JvmName(name = "immutableOf")

fun KmValueParameter.toImmutable(): ImmutableKmValueParameter

@JvmName(name = "immutableOf")

fun KmVersionRequirement.toImmutable(): ImmutableKmVersionRequirement

toImmutableKmClass

fun Class<*>.toImmutableKmClass(): ImmutableKmClass

fun TypeElement.toImmutableKmClass(): ImmutableKmClass

fun Metadata.toImmutableKmClass(): ImmutableKmClass

fun KClass<*>.toImmutableKmClass(): ImmutableKmClass

fun KotlinClassMetadata.Class.toImmutableKmClass(): ImmutableKmClass

Visits metadata of this class with a new KmClass instance and returns an ImmutableKmClass instance of its values.

toImmutableKmPackage

fun KotlinClassMetadata.FileFacade.toImmutableKmPackage(): ImmutableKmPackage

Visits metadata of this class with a new KmPackage instance and returns an ImmutableKmPackage instance of its values.

toKotlinClassMetadata

inline fun <T : KotlinClassMetadata> Metadata.toKotlinClassMetadata(): T

Properties

declaresDefaultValue

val KmValueParameter.declaresDefaultValue: Boolean

declaresDefaultValue

val ImmutableKmValueParameter.declaresDefaultValue: Boolean

getterPropertyAccessorFlags

val ImmutableKmProperty.getterPropertyAccessorFlags: Set<PropertyAccessorFlag>

hasAnnotations

val Flags.hasAnnotations: Boolean

hasAnnotations

val ImmutableKmWithFlags.hasAnnotations: Boolean

hasConstant

val KmProperty.hasConstant: Boolean

hasConstant

val ImmutableKmProperty.hasConstant: Boolean

hasGetter

val KmProperty.hasGetter: Boolean

hasGetter

val ImmutableKmProperty.hasGetter: Boolean

hasSetter

val KmProperty.hasSetter: Boolean

hasSetter

val ImmutableKmProperty.hasSetter: Boolean

isAbstract

val Flags.isAbstract: Boolean

isAbstract

val ImmutableKmWithFlags.isAbstract: Boolean

isAnnotation

val KmClass.isAnnotation: Boolean

isAnnotation

val ImmutableKmClass.isAnnotation: Boolean

isAnnotationClass

val Flags.isAnnotationClass: Boolean

isClass

val Flags.isClass: Boolean

isClass

val KmClass.isClass: Boolean

isClass

val ImmutableKmClass.isClass: Boolean

isCompanionObject

val KmClass.isCompanionObject: Boolean

isCompanionObject

val ImmutableKmClass.isCompanionObject: Boolean

isCompanionObjectClass

val Flags.isCompanionObjectClass: Boolean

isConst

val KmProperty.isConst: Boolean

isConst

val ImmutableKmProperty.isConst: Boolean

isCrossInline

val KmValueParameter.isCrossInline: Boolean

isCrossInline

val ImmutableKmValueParameter.isCrossInline: Boolean

isData

val KmClass.isData: Boolean

isData

val ImmutableKmClass.isData: Boolean

isDataClass

val Flags.isDataClass: Boolean

isDeclaration

val KmFunction.isDeclaration: Boolean

isDeclaration

val ImmutableKmFunction.isDeclaration: Boolean

isDeclaration

val KmProperty.isDeclaration: Boolean

isDeclaration

val ImmutableKmProperty.isDeclaration: Boolean

isDeclarationFunction

val Flags.isDeclarationFunction: Boolean

isDelegated

val KmProperty.isDelegated: Boolean

isDelegated

val ImmutableKmProperty.isDelegated: Boolean

isDelegation

val KmFunction.isDelegation: Boolean

isDelegation

val ImmutableKmFunction.isDelegation: Boolean

isDelegation

val KmProperty.isDelegation: Boolean

isDelegation

val ImmutableKmProperty.isDelegation: Boolean

isDelegationFunction

val Flags.isDelegationFunction: Boolean

isEnum

val KmClass.isEnum: Boolean

isEnum

val ImmutableKmClass.isEnum: Boolean

isEnumClass

val Flags.isEnumClass: Boolean

isEnumEntry

val KmClass.isEnumEntry: Boolean

isEnumEntry

val ImmutableKmClass.isEnumEntry: Boolean

isEnumEntryClass

val Flags.isEnumEntryClass: Boolean

isExpect

val KmClass.isExpect: Boolean

isExpect

val ImmutableKmClass.isExpect: Boolean

isExpect

val KmFunction.isExpect: Boolean

isExpect

val ImmutableKmFunction.isExpect: Boolean

isExpect

val KmProperty.isExpect: Boolean

isExpect

val ImmutableKmProperty.isExpect: Boolean

isExpectClass

val Flags.isExpectClass: Boolean

isExpectFunction

val Flags.isExpectFunction: Boolean

isExternal

val KmClass.isExternal: Boolean

isExternal

val ImmutableKmClass.isExternal: Boolean

isExternal

val KmFunction.isExternal: Boolean

isExternal

val ImmutableKmFunction.isExternal: Boolean

isExternal

val KmProperty.isExternal: Boolean

isExternal

val ImmutableKmProperty.isExternal: Boolean

isExternalClass

val Flags.isExternalClass: Boolean

isExternalFunction

val Flags.isExternalFunction: Boolean

isFakeOverride

val KmFunction.isFakeOverride: Boolean

isFakeOverride

val ImmutableKmFunction.isFakeOverride: Boolean

isFakeOverride

val KmProperty.isFakeOverride: Boolean

isFakeOverride

val ImmutableKmProperty.isFakeOverride: Boolean

isFakeOverrideFunction

val Flags.isFakeOverrideFunction: Boolean

isFakeOverrideProperty

val Flags.isFakeOverrideProperty: Boolean

isFinal

val Flags.isFinal: Boolean

isFinal

val ImmutableKmWithFlags.isFinal: Boolean

isFun

val Flags.isFun: Boolean

isFun

val ImmutableKmClass.isFun: Boolean

isInfix

val KmFunction.isInfix: Boolean

isInfix

val ImmutableKmFunction.isInfix: Boolean

isInfixFunction

val Flags.isInfixFunction: Boolean

isInline

val KmClass.isInline: Boolean

isInline

val ImmutableKmClass.isInline: Boolean

isInline

val KmFunction.isInline: Boolean

isInline

val ImmutableKmFunction.isInline: Boolean

isInlineClass

val Flags.isInlineClass: Boolean

isInlineFunction

val Flags.isInlineFunction: Boolean

isInner

val KmClass.isInner: Boolean

isInner

val ImmutableKmClass.isInner: Boolean

isInnerClass

val Flags.isInnerClass: Boolean

isInterface

val Flags.isInterface: Boolean

isInterface

val KmClass.isInterface: Boolean

isInterface

val ImmutableKmClass.isInterface: Boolean

isInternal

val Flags.isInternal: Boolean

isInternal

val ImmutableKmWithFlags.isInternal: Boolean

isLateinit

val KmProperty.isLateinit: Boolean

isLateinit

val ImmutableKmProperty.isLateinit: Boolean

isLocal

val Flags.isLocal: Boolean

isLocal

val ImmutableKmWithFlags.isLocal: Boolean

isNoInline

val KmValueParameter.isNoInline: Boolean

isNoInline

val ImmutableKmValueParameter.isNoInline: Boolean

isNullable

val KmType.isNullable: Boolean

isNullable

val ImmutableKmType.isNullable: Boolean

isNullableType

val Flags.isNullableType: Boolean

isObject

val KmClass.isObject: Boolean

isObject

val ImmutableKmClass.isObject: Boolean

isObjectClass

val Flags.isObjectClass: Boolean

isOpen

val Flags.isOpen: Boolean

isOpen

val ImmutableKmWithFlags.isOpen: Boolean

isOperator

val KmFunction.isOperator: Boolean

isOperator

val ImmutableKmFunction.isOperator: Boolean

isOperatorFunction

val Flags.isOperatorFunction: Boolean

isPrimary

val KmConstructor.isPrimary: Boolean

isPrimary

val ImmutableKmConstructor.isPrimary: Boolean

isPrimaryConstructor

val Flags.isPrimaryConstructor: Boolean

isPrivate

val Flags.isPrivate: Boolean

isPrivate

val ImmutableKmWithFlags.isPrivate: Boolean

isPrivate_to_this

val Flags.isPrivate_to_this: Boolean

isPrivate_to_this

val ImmutableKmWithFlags.isPrivate_to_this: Boolean

isPropertyAccessorExternal

val Flags.isPropertyAccessorExternal: Boolean

isPropertyAccessorInline

val Flags.isPropertyAccessorInline: Boolean

isPropertyAccessorNotDefault

val Flags.isPropertyAccessorNotDefault: Boolean

isProtected

val Flags.isProtected: Boolean

isProtected

val ImmutableKmWithFlags.isProtected: Boolean

isPublic

val Flags.isPublic: Boolean

isPublic

val ImmutableKmWithFlags.isPublic: Boolean

isReified

val KmTypeParameter.isReified: Boolean

isReified

val ImmutableKmTypeParameter.isReified: Boolean

isSealed

val Flags.isSealed: Boolean

isSealed

val ImmutableKmWithFlags.isSealed: Boolean

isSecondary

val KmConstructor.isSecondary: Boolean

isSecondary

val ImmutableKmConstructor.isSecondary: Boolean

isSuspend

val KmType.isSuspend: Boolean

isSuspend

val ImmutableKmType.isSuspend: Boolean

isSuspend

val KmFunction.isSuspend: Boolean

isSuspend

val ImmutableKmFunction.isSuspend: Boolean

isSuspendFunction

val Flags.isSuspendFunction: Boolean

isSuspendType

val Flags.isSuspendType: Boolean

isSynthesized

val KmFunction.isSynthesized: Boolean

isSynthesized

val ImmutableKmFunction.isSynthesized: Boolean

isSynthesized

val KmProperty.isSynthesized: Boolean

isSynthesized

val ImmutableKmProperty.isSynthesized: Boolean

isSynthesizedFunction

val Flags.isSynthesizedFunction: Boolean

isTailRec

val KmFunction.isTailRec: Boolean

isTailRec

val ImmutableKmFunction.isTailRec: Boolean

isTailRecFunction

val Flags.isTailRecFunction: Boolean

isVal

val KmProperty.isVal: Boolean

isVal

val ImmutableKmProperty.isVal: Boolean

isVar

val KmProperty.isVar: Boolean

isVar

val ImmutableKmProperty.isVar: Boolean

propertyAccessorFlags

val Flags.propertyAccessorFlags: Set<PropertyAccessorFlag>

setterPropertyAccessorFlags

val ImmutableKmProperty.setterPropertyAccessorFlags: Set<PropertyAccessorFlag>