com.squareup.wire

Annotation Type WireField

@Target(value=FIELD)
 @Retention(value=RUNTIME)
public @interface WireField

Annotates generated Message fields with metadata for serialization and deserialization.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	adapter Reference to the static field that holds a ProtoAdapter that can encode and decode this field's values.
int	tag The tag number used to store the field's value.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	keyAdapter Reference to the static field that holds a ProtoAdapter that can encode and decode this field's keys.
WireField.Label	label The field's protocol buffer label, one of WireField.Label.OPTIONAL, WireField.Label.REQUIRED, WireField.Label.REPEATED, or WireField.Label.PACKED.
boolean	redacted Redacted fields are omitted from toString() to protect sensitive data.

Element Detail

tag

public abstract int tag

The tag number used to store the field's value.

adapter

public abstract String adapter

Reference to the static field that holds a ProtoAdapter that can encode and decode this field's values. The reference is a string like com.squareup.wire.protos.person.Person#ADAPTER and contains a fully-qualified class name followed by a hash symbol and a field name.

keyAdapter

public abstract String keyAdapter

Reference to the static field that holds a ProtoAdapter that can encode and decode this field's keys. This only applies to maps. See adapter() for a description of the value format.

Default:

""

label

public abstract WireField.Label label

The field's protocol buffer label, one of WireField.Label.OPTIONAL, WireField.Label.REQUIRED, WireField.Label.REPEATED, or WireField.Label.PACKED. Defaults to WireField.Label.OPTIONAL.

Default:

com.squareup.wire.WireField.Label.OPTIONAL

redacted

public abstract boolean redacted

Redacted fields are omitted from toString() to protect sensitive data. Defaults to false.

Default:

false