wire-runtime/com.squareup.wire.internal/FieldBinding

FieldBinding

class FieldBinding<M : Message<M, B>, B : Message.Builder<M, B>> : FieldOrOneOfBinding<M, B>

Read, write, and describe a tag within a message. This class knows how to assign fields to a builder object, and how to extract values from a message object.

Types

Companion

object Companion

Properties

adapter

val adapter: ProtoAdapter<Any>

declaredName

open override val declaredName: String

The name of the field as declared in the .proto file.

isMap

open override val isMap: Boolean

isMessage

open override val isMessage: Boolean

keyAdapter

open override val keyAdapter: ProtoAdapter<*>

label

open override val label: WireField.Label

name

open override val name: String

The name of the field in generated code. If the declared name is a keyword like fun, this will be a transformed name like fun_.

redacted

open override val redacted: Boolean

singleAdapter

open override val singleAdapter: ProtoAdapter<*>

tag

open override val tag: Int

wireFieldJsonName

open override val wireFieldJsonName: String

The JSON name as determined at code-generation name. This is usually camelCase even if the field is declared in snake_case.

writeIdentityValues

open override val writeIdentityValues: Boolean

If true, Wire will always write identity values.

Functions

get

open operator override fun get(message: M): Any?

getFromBuilder

open override fun getFromBuilder(builder: B): Any?

omitFromJson

fun omitFromJson(syntax: Syntax, value: Any?): Boolean

set

open override fun set(builder: B, value: Any?)

Assign a single value for required/optional fields, or a list for repeated/packed fields.

value

open override fun value(builder: B, value: Any)

Accept a single value, independent of whether this value is single or repeated.