kotlinpoet/com.squareup.kotlinpoet/PropertySpec/Builder

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>

Properties

Link copied to clipboard
open override val annotations: MutableList<AnnotationSpec>
Link copied to clipboard
open override val contextParameters: MutableList<ContextParameter>

Mutable list of the current context parameters this builder contains.

Link copied to clipboard
open override val contextReceiverTypes: MutableList<TypeName>

Mutable map of the current originating elements this builder contains.

Link copied to clipboard
open override val kdoc: CodeBlock.Builder
Link copied to clipboard
Link copied to clipboard
open override val originatingElements: MutableList<Element>

Mutable map of the current originating elements this builder contains.

Link copied to clipboard
open override val tags: MutableMap<KClass<*>, Any>

Mutable map of the current tags this builder contains.

Link copied to clipboard

Functions

Link copied to clipboard
open override fun addAnnotation(annotationSpec: AnnotationSpec): PropertySpec.Builder
open override 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.")
open override fun addAnnotation(annotation: Class<*>): PropertySpec.Builder
open override fun addAnnotation(annotation: KClass<*>): PropertySpec.Builder
Link copied to clipboard
open override fun addAnnotations(annotationSpecs: Iterable<AnnotationSpec>): PropertySpec.Builder
Link copied to clipboard
open override fun addKdoc(block: CodeBlock): PropertySpec.Builder
open override fun addKdoc(format: String, vararg args: Any): PropertySpec.Builder
Link copied to clipboard
Link copied to clipboard
open fun addOriginatingElement(originatingElement: Element): PropertySpec.Builder

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun build(): PropertySpec
Link copied to clipboard
open fun contextParameter(contextParameter: ContextParameter): PropertySpec.Builder

Adds the given ContextParameter to this type's list of context parameters.

open fun contextParameter(type: TypeName): PropertySpec.Builder

Adds a context parameter with the name "_" and type to this type's list of context parameters.

open fun contextParameter(name: String, type: TypeName): PropertySpec.Builder
@DelicateKotlinPoetApi(message = "Java reflection APIs don't give complete information on Kotlin types. Consider using the kotlinpoet-metadata APIs instead.")
open fun contextParameter(name: String, type: Type): PropertySpec.Builder
open fun contextParameter(name: String, type: KClass<*>): PropertySpec.Builder

Adds a context parameter with the given name and type to this type's list of context parameters.

Link copied to clipboard
open fun contextParameters(parameters: Iterable<ContextParameter>): PropertySpec.Builder

Adds the given parameters to this type's list of context parameters.

Link copied to clipboard
open fun contextReceivers(vararg receiverTypes: TypeName): PropertySpec.Builder
open fun contextReceivers(receiverTypes: Iterable<TypeName>): PropertySpec.Builder

Adds the given receiverTypes to this type's list of originating elements.

Link copied to clipboard
fun delegate(codeBlock: CodeBlock): PropertySpec.Builder
fun delegate(format: String, vararg args: Any?): PropertySpec.Builder
Link copied to clipboard
fun getter(getter: FunSpec?): PropertySpec.Builder
Link copied to clipboard
fun initializer(codeBlock: CodeBlock?): PropertySpec.Builder
fun initializer(format: String, vararg args: Any?): PropertySpec.Builder
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun mutable(mutable: Boolean = true): PropertySpec.Builder

True to create a var instead of a val.

Link copied to clipboard
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
Link copied to clipboard
fun setter(setter: FunSpec?): PropertySpec.Builder
Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
Link copied to clipboard