Class: ExtensionField

ProtoBuf.Reflect.Message. ExtensionField

new ExtensionField(buildernon-null, messagenon-null, rule, type, name, id, optionsopt)

Constructs a new Message ExtensionField.

Parameters:
Name Type Attributes Description
builder ProtoBuf.Builder

Builder reference

message ProtoBuf.Reflect.Message

Message reference

rule string

Rule, one of requried, optional, repeated

type string

Data type, e.g. int32

name string

Field name

id number

Unique field id

options Object.<string, *> <optional>

Options

Source:

Extends

Members

(non-null) builder :ProtoBuf.Builder

Builder reference.

Type:
Inherited From:
Source:

className

Inherited From:
Source:

defaultValue :*

Default value.

Type:
  • *
Inherited From:
Source:

element :ProtoBuf.Element

Element implementation. Created in build() after types are resolved.

Type:
  • ProtoBuf.Element
Inherited From:
Source:

(non-null) extension :ProtoBuf.Reflect.Extension

Extension reference.

Type:
Source:

id :number

Unique message field id.

Type:
  • number
Inherited From:
Source:

keyElement :ProtoBuf.Element

Key element implementation, for map fields. Created in build() after types are resolved.

Type:
  • ProtoBuf.Element
Inherited From:
Source:

keyType :string|Object|null

Message field key type. Type reference string if unresolved, protobuf type if resolved. Valid only if this.map === true, null otherwise.

Type:
  • string | Object | null
Inherited From:
Source:

map :boolean

Message field map flag.

Type:
  • boolean
Inherited From:
Source:

name :string

Object name in namespace.

Type:
  • string
Inherited From:
Source:

(nullable) oneof :ProtoBuf.Reflect.Message.OneOf

Enclosing OneOf.

Type:
Inherited From:
Source:

(non-null) options :Object.<string, *>

Message field options.

Type:
  • Object.<string, *>
Inherited From:
Source:

originalName :string

Original field name.

Type:
  • string
Inherited From:
Source:

(nullable) parent :ProtoBuf.Reflect.T

Parent object.

Type:
Inherited From:
Source:

repeated :boolean

Message field repeated flag.

Type:
  • boolean
Inherited From:
Source:

required :boolean

Message field required flag.

Type:
  • boolean
Inherited From:
Source:

resolvedType :ProtoBuf.Reflect.T|null

Resolved type reference inside the global namespace.

Type:
Inherited From:
Source:

syntax :string

Syntax level of this definition (e.g., proto3).

Type:
  • string
Inherited From:
Source:

type :string|Object

Message field type. Type reference string if unresolved, protobuf type if resolved. In a map field, this is the value type.

Type:
  • string | Object
Inherited From:
Source:

Methods

build()

Builds the field.

Inherited From:
Source:

calculate(value) → {number}

Calculates the length of this field's value on the network level.

Parameters:
Name Type Description
value *

Field value

Inherited From:
Source:
Returns:

Byte length

Type
number

decode(wireType, buffer, skipRepeatedopt) → {*}

Decode the field value from the specified buffer.

Parameters:
Name Type Attributes Description
wireType number

Leading wire type

buffer ByteBuffer

ByteBuffer to decode from

skipRepeated boolean <optional>

Whether to skip the repeated check or not. Defaults to false.

Inherited From:
Source:
Throws:
If the field cannot be decoded
Type
Error
Returns:

Decoded value: array for packed repeated fields, [key, value] for map fields, or an individual value otherwise.

Type
*

encode(value, buffer) → {ByteBuffer}

Encodes the specified field value to the specified buffer.

Parameters:
Name Type Description
value *

Verified field value

buffer ByteBuffer

ByteBuffer to encode to

Inherited From:
Source:
Throws:
If the field cannot be encoded
Type
Error
Returns:

The ByteBuffer for chaining

Type
ByteBuffer

fqn() → {string}

Returns the fully qualified name of this object.

Inherited From:
Source:
Returns:

Fully qualified name as of ".PATH.TO.THIS"

Type
string

hasWirePresence(value) → {boolean}

Determines whether the field will have a presence on the wire given its value.

Parameters:
Name Type Description
value *

Verified field value

Inherited From:
Source:
Returns:

Whether the field will be present on the wire

Type
boolean

toString(includeClassopt)

Returns a string representation of this Reflect object (its fully qualified name).

Parameters:
Name Type Attributes Description
includeClass boolean <optional>

Set to true to include the class name. Defaults to false.

Inherited From:
Source:
Returns:

String representation

verifyValue(value, skipRepeatedopt) → {*}

Checks if the given value can be set for this field.

Parameters:
Name Type Attributes Description
value *

Value to check

skipRepeated boolean <optional>

Whether to skip the repeated value check or not. Defaults to false.

Inherited From:
Source:
Throws:
If the value cannot be set for this field
Type
Error
Returns:

Verified, maybe adjusted, value

Type
*