kotlinpoet/com.squareup.kotlinpoet/PropertySpec

PropertySpec

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

A generated property declaration.

Types

Builder

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

Companion

object Companion

Properties

annotations

open override val annotations: List<AnnotationSpec>

backingFieldInitializer

val backingFieldInitializer: CodeBlock?

backingFieldType

val backingFieldType: TypeName

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.

delegated

val delegated: Boolean

getter

val getter: FunSpec?

initializer

val initializer: CodeBlock?

kdoc

open override val kdoc: CodeBlock

modifiers

val modifiers: Set<KModifier>

mutable

val mutable: Boolean

name

val name: String

originatingElements

open override val originatingElements: List<Element>

The originating elements of this type.

receiverType

val receiverType: TypeName?

setter

val setter: FunSpec?

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?

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, type: TypeName = this.type): PropertySpec.Builder

toString

open override fun toString(): String