Package com.squareup.kotlinpoet.metadata

Types

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. This exists because kotlinx-metadata is not a stable API, and will remain in place until it is.

PropertyAccessorFlag

enum PropertyAccessorFlag : Enum<PropertyAccessorFlag>

Functions

readKotlinClassMetadata

fun Metadata.readKotlinClassMetadata(): KotlinClassMetadata

Returns the KotlinClassMetadata this represents. In general you should only use this function when you don't know what the underlying KotlinClassMetadata subtype is, otherwise you should use one of the more direct functions like toKmClass.

toKmClass

fun Class<*>.toKmClass(): KmClass

fun TypeElement.toKmClass(): KmClass

fun Metadata.toKmClass(): KmClass

fun KClass<*>.toKmClass(): KmClass

toKotlinClassMetadata

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

Properties

declaresDefaultValue

val KmValueParameter.declaresDefaultValue: Boolean

getterPropertyAccessorFlags

val KmProperty.getterPropertyAccessorFlags: Set<PropertyAccessorFlag>

hasAnnotations

val Flags.hasAnnotations: Boolean

hasConstant

val KmProperty.hasConstant: Boolean

hasGetter

val KmProperty.hasGetter: Boolean

hasSetter

val KmProperty.hasSetter: Boolean

isAbstract

val Flags.isAbstract: Boolean

isAnnotation

val KmClass.isAnnotation: Boolean

isAnnotationClass

val Flags.isAnnotationClass: Boolean

isClass

val Flags.isClass: Boolean

isClass

val KmClass.isClass: Boolean

isCompanionObject

val KmClass.isCompanionObject: Boolean

isCompanionObjectClass

val Flags.isCompanionObjectClass: Boolean

isConst

val KmProperty.isConst: Boolean

isCrossInline

val KmValueParameter.isCrossInline: Boolean

isData

val KmClass.isData: Boolean

isDataClass

val Flags.isDataClass: Boolean

isDeclaration

val KmFunction.isDeclaration: Boolean

isDeclaration

val KmProperty.isDeclaration: Boolean

isDeclarationFunction

val Flags.isDeclarationFunction: Boolean

isDelegated

val KmProperty.isDelegated: Boolean

isDelegation

val KmFunction.isDelegation: Boolean

isDelegation

val KmProperty.isDelegation: Boolean

isDelegationFunction

val Flags.isDelegationFunction: Boolean

isEnum

val KmClass.isEnum: Boolean

isEnumClass

val Flags.isEnumClass: Boolean

isEnumEntry

val KmClass.isEnumEntry: Boolean

isEnumEntryClass

val Flags.isEnumEntryClass: Boolean

isExpect

val KmClass.isExpect: Boolean

isExpect

val KmFunction.isExpect: Boolean

isExpect

val KmProperty.isExpect: Boolean

isExpectClass

val Flags.isExpectClass: Boolean

isExpectFunction

val Flags.isExpectFunction: Boolean

isExternal

val KmClass.isExternal: Boolean

isExternal

val KmFunction.isExternal: Boolean

isExternal

val KmProperty.isExternal: Boolean

isExternalClass

val Flags.isExternalClass: Boolean

isExternalFunction

val Flags.isExternalFunction: Boolean

isFakeOverride

val KmFunction.isFakeOverride: Boolean

isFakeOverride

val KmProperty.isFakeOverride: Boolean

isFakeOverrideFunction

val Flags.isFakeOverrideFunction: Boolean

isFakeOverrideProperty

val Flags.isFakeOverrideProperty: Boolean

isFinal

val Flags.isFinal: Boolean

isFun

val Flags.isFun: Boolean

isFun

val KmClass.isFun: Boolean

isInfix

val KmFunction.isInfix: Boolean

isInfixFunction

val Flags.isInfixFunction: Boolean

isInline

val KmFunction.isInline: Boolean

isInlineFunction

val Flags.isInlineFunction: Boolean

isInner

val KmClass.isInner: Boolean

isInnerClass

val Flags.isInnerClass: Boolean

isInterface

val Flags.isInterface: Boolean

isInterface

val KmClass.isInterface: Boolean

isInternal

val Flags.isInternal: Boolean

isLateinit

val KmProperty.isLateinit: Boolean

isLocal

val Flags.isLocal: Boolean

isNoInline

val KmValueParameter.isNoInline: Boolean

isNullable

val KmType.isNullable: Boolean

isNullableType

val Flags.isNullableType: Boolean

isObject

val KmClass.isObject: Boolean

isObjectClass

val Flags.isObjectClass: Boolean

isOpen

val Flags.isOpen: Boolean

isOperator

val KmFunction.isOperator: Boolean

isOperatorFunction

val Flags.isOperatorFunction: Boolean

isPrimary

val KmConstructor.isPrimary: Boolean

isPrimaryConstructor

val Flags.isPrimaryConstructor: Boolean

isPrivate

val Flags.isPrivate: Boolean

isPrivate_to_this

val Flags.isPrivate_to_this: Boolean

isPropertyAccessorExternal

val Flags.isPropertyAccessorExternal: Boolean

isPropertyAccessorInline

val Flags.isPropertyAccessorInline: Boolean

isPropertyAccessorNotDefault

val Flags.isPropertyAccessorNotDefault: Boolean

isProtected

val Flags.isProtected: Boolean

isPublic

val Flags.isPublic: Boolean

isReified

val KmTypeParameter.isReified: Boolean

isSealed

val Flags.isSealed: Boolean

isSecondary

val KmConstructor.isSecondary: Boolean

isSuspend

val KmType.isSuspend: Boolean

isSuspend

val KmFunction.isSuspend: Boolean

isSuspendFunction

val Flags.isSuspendFunction: Boolean

isSuspendType

val Flags.isSuspendType: Boolean

isSynthesized

val KmFunction.isSynthesized: Boolean

isSynthesized

val KmProperty.isSynthesized: Boolean

isSynthesizedFunction

val Flags.isSynthesizedFunction: Boolean

isTailRec

val KmFunction.isTailRec: Boolean

isTailRecFunction

val Flags.isTailRecFunction: Boolean

isVal

val KmProperty.isVal: Boolean

isValue

val KmClass.isValue: Boolean

isValueClass

val Flags.isValueClass: Boolean

isVar

val KmProperty.isVar: Boolean

propertyAccessorFlags

val Flags.propertyAccessorFlags: Set<PropertyAccessorFlag>

setterPropertyAccessorFlags

val KmProperty.setterPropertyAccessorFlags: Set<PropertyAccessorFlag>