kotlinpoet/com.squareup.kotlinpoet/PropertySpec/Builder

Builder

class Builder : Taggable.Builder<PropertySpec.Builder> , OriginatingElementsHolder.Builder<PropertySpec.Builder>

Functions

fun addAnnotation(annotationSpec: AnnotationSpec): PropertySpec.Builder

fun addAnnotation(annotation: ClassName): PropertySpec.Builder

@DelicateKotlinPoetApi(message = "Java reflection APIs don't give complete information on Kotlin types. Consider using the kotlinpoet-metadata APIs instead.")

fun addAnnotation(annotation: Class<*>): PropertySpec.Builder

fun addAnnotation(annotation: KClass<*>): PropertySpec.Builder

addAnnotations

fun addAnnotations(annotationSpecs: Iterable<AnnotationSpec>): PropertySpec.Builder

addKdoc

fun addKdoc(block: CodeBlock): PropertySpec.Builder

fun addKdoc(format: String, vararg args: Any): PropertySpec.Builder

addModifiers

fun addModifiers(vararg modifiers: KModifier): PropertySpec.Builder

fun addModifiers(modifiers: Iterable<KModifier>): PropertySpec.Builder

addOriginatingElement

open fun addOriginatingElement(originatingElement: Element): PropertySpec.Builder

Adds an originatingElement to this type's list of originating elements.

addTypeVariable

fun addTypeVariable(typeVariable: TypeVariableName): PropertySpec.Builder

addTypeVariables

fun addTypeVariables(typeVariables: Iterable<TypeVariableName>): PropertySpec.Builder

build

fun build(): PropertySpec

delegate

fun delegate(codeBlock: CodeBlock): PropertySpec.Builder

fun delegate(format: String, vararg args: Any?): PropertySpec.Builder

getter

fun getter(getter: FunSpec?): PropertySpec.Builder

initializer

fun initializer(codeBlock: CodeBlock?): PropertySpec.Builder

fun initializer(format: String, vararg args: Any?): PropertySpec.Builder

mutable

fun mutable(mutable: Boolean = true): PropertySpec.Builder

True to create a var instead of a val.

receiver

fun receiver(receiverType: TypeName?): PropertySpec.Builder

@DelicateKotlinPoetApi(message = "Java reflection APIs don't give complete information on Kotlin types. Consider using the kotlinpoet-metadata APIs instead.")

fun receiver(receiverType: Type): PropertySpec.Builder

fun receiver(receiverType: KClass<*>): PropertySpec.Builder

setter

fun setter(setter: FunSpec?): PropertySpec.Builder

tag

open fun tag(type: Class<*>, tag: Any?): PropertySpec.Builder

open fun tag(type: KClass<*>, tag: Any?): PropertySpec.Builder

Attaches tag to the request using type as a key. Tags can be read from a request using Taggable.tag. Use null to remove any existing tag assigned for type.

Properties

annotations

val annotations: MutableList<AnnotationSpec>

modifiers

val modifiers: MutableList<KModifier>

originatingElements

open override val originatingElements: MutableList<Element>

Mutable map of the current originating elements this builder contains.

Extensions

jvmField

fun PropertySpec.Builder.jvmField(): PropertySpec.Builder

jvmStatic

fun PropertySpec.Builder.jvmStatic(): PropertySpec.Builder

jvmSuppressWildcards

fun PropertySpec.Builder.jvmSuppressWildcards(suppress: Boolean = true): PropertySpec.Builder

tag

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

Attaches tag to the request using T as a key. Tags can be read from a request using Taggable.tag. Use null to remove any existing tag assigned for T.

transient

fun PropertySpec.Builder.transient(): PropertySpec.Builder

volatile

fun PropertySpec.Builder.volatile(): PropertySpec.Builder