kotlinpoet / com.squareup.kotlinpoet / MemberName

MemberName

data class MemberName

Represents the name of a member (such as a function or a property).

Parameters

packageName - e.g. kotlin.collections

enclosingClassName - e.g. Map.Entry.Companion, if the member is declared inside the companion object of the Map.Entry class

simpleName - e.g. isBlank, size

Constructors

<init>

MemberName(packageName: String, simpleName: String)
MemberName(enclosingClassName: ClassName, simpleName: String)

Properties

canonicalName

val canonicalName: String

Fully qualified name using . as a separator, like kotlin.String.isBlank.

enclosingClassName

val enclosingClassName: ClassName?

e.g. Map.Entry.Companion, if the member is declared inside the companion object of the Map.Entry class

packageName

val packageName: String

e.g. kotlin.collections

simpleName

val simpleName: String

e.g. isBlank, size

Functions

reference

fun reference(): CodeBlock

Callable reference to this member. Emits enclosingClassName if it exists, followed by the reference operator ::, followed by either simpleName or the fully-qualified name if this is a top-level member.

toString

fun toString(): String

Companion Object Functions

member

fun ClassName.member(simpleName: String): MemberName
fun KClass<*>.member(simpleName: String): MemberName
fun Class<*>.member(simpleName: String): MemberName