kotlinpoet/com.squareup.kotlinpoet/FunSpec

FunSpec

class FunSpec : Taggable, OriginatingElementsHolder, ContextReceivable, ContextParameterizable, Annotatable, Documentable

A generated function declaration.

Types

Builder

class Builder : Taggable.Builder<FunSpec.Builder> , OriginatingElementsHolder.Builder<FunSpec.Builder> , ContextReceivable.Builder<FunSpec.Builder> , ContextParameterizable.Builder<FunSpec.Builder> , Annotatable.Builder<FunSpec.Builder> , Documentable.Builder<FunSpec.Builder>

Companion

object Companion

Properties

annotations

open override val annotations: List<AnnotationSpec>

body

val body: CodeBlock

contextParameters

open override val contextParameters: List<ContextParameter>

The context parameters of this type.

contextReceiverTypes

open override val contextReceiverTypes: List<TypeName>

The originating elements of this type.

delegateConstructor

val delegateConstructor: String?

delegateConstructorArguments

val delegateConstructorArguments: List<CodeBlock>

isAccessor

val isAccessor: Boolean

isConstructor

val isConstructor: Boolean

kdoc

open override val kdoc: CodeBlock

modifiers

val modifiers: Set<KModifier>

name

val name: String

originatingElements

open override val originatingElements: List<Element>

The originating elements of this type.

parameters

val parameters: List<ParameterSpec>

receiverKdoc

val receiverKdoc: CodeBlock

receiverType

val receiverType: TypeName?

returnKdoc

val returnKdoc: CodeBlock

returnType

val returnType: TypeName

Functions

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

tag

open override fun <T : Any> tag(type: Class<T>): T?

Returns the tag attached with type as a key, or null if no tag is attached with that key.

open override fun <T : Any> tag(type: KClass<T>): T?

Returns the tag attached with type as a key, or null if no tag is attached with that key.

tag

inline fun <T : Any> Taggable.tag(): T?

Returns the tag attached with T as a key, or null if no tag is attached with that key.

toBuilder

@JvmOverloads

fun toBuilder(name: String = this.name): FunSpec.Builder

toString

open override fun toString(): String