Top Description Inners Fields Constructors Methods
com.google.protobuf

public final Class WireFormat

extends Object
Class Inheritance
Imports
java.io.IOException
This class is used internally by the Protocol Buffer library and generated message implementations. It is public only because those generated messages do not reside in the protobuf package. Others should not use this class directly.

This class contains constants and helper functions useful for dealing with the Protocol Buffer wire format.

Author
[email protected] Kenton Varda

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
WireFormat.FieldType

Lite equivalent to Descriptors.FieldDescriptor.Type.

public static enum
WireFormat.JavaType

Lite equivalent to Descriptors.FieldDescriptor.JavaType.

pack-priv static enum
WireFormat.Utf8Validation

Validation level for handling incoming string field data which potentially contain non-UTF8 bytes.

Field Summary

Modifier and TypeField and Description
pack-priv static final int
FIXED32_SIZE

pack-priv static final int
FIXED64_SIZE

pack-priv static final int
MAX_VARINT32_SIZE

pack-priv static final int
MAX_VARINT64_SIZE

pack-priv static final int
MAX_VARINT_SIZE

pack-priv static final int
MESSAGE_SET_ITEM

pack-priv static final int
MESSAGE_SET_ITEM_END_TAG

pack-priv static final int
MESSAGE_SET_ITEM_TAG

pack-priv static final int
MESSAGE_SET_MESSAGE

pack-priv static final int
MESSAGE_SET_MESSAGE_TAG

pack-priv static final int
MESSAGE_SET_TYPE_ID

pack-priv static final int
MESSAGE_SET_TYPE_ID_TAG

pack-priv static final int
TAG_TYPE_BITS

pack-priv static final int
TAG_TYPE_MASK

public static final int
WIRETYPE_END_GROUP

public static final int
WIRETYPE_FIXED32

public static final int
WIRETYPE_FIXED64

public static final int
WIRETYPE_LENGTH_DELIMITED

public static final int
WIRETYPE_START_GROUP

public static final int
WIRETYPE_VARINT

Constructor Summary

AccessConstructor and Description
private
WireFormat()

Method Summary

Modifier and TypeMethod and Description
public static int
getTagFieldNumber(final int tag)

Given a tag value, determines the field number (the upper 29 bits).

public static int
getTagWireType(final int tag)

Given a tag value, determines the wire type (the lower 3 bits).

pack-priv static int
makeTag(final int fieldNumber, final int wireType)

Makes a tag value given a field number and wire type.

pack-priv static Object

Returns:

An object representing the field's value, of the exact type which would be returned by Message#getField(Descriptors.FieldDescriptor) for this field.
readPrimitiveField(CodedInputStream
The stream from which to read.
input, WireFormat.FieldType
Declared type of the field.
type, WireFormat.Utf8Validation
Different string UTF8 validation level for handling string fields.
utf8Validation)

Read a field of any primitive type for immutable messages from a CodedInputStream.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

FIXED32_SIZEback to summary
pack-priv static final int FIXED32_SIZE
FIXED64_SIZEback to summary
pack-priv static final int FIXED64_SIZE
MAX_VARINT32_SIZEback to summary
pack-priv static final int MAX_VARINT32_SIZE
MAX_VARINT64_SIZEback to summary
pack-priv static final int MAX_VARINT64_SIZE
MAX_VARINT_SIZEback to summary
pack-priv static final int MAX_VARINT_SIZE
MESSAGE_SET_ITEMback to summary
pack-priv static final int MESSAGE_SET_ITEM
MESSAGE_SET_ITEM_END_TAGback to summary
pack-priv static final int MESSAGE_SET_ITEM_END_TAG
MESSAGE_SET_ITEM_TAGback to summary
pack-priv static final int MESSAGE_SET_ITEM_TAG
MESSAGE_SET_MESSAGEback to summary
pack-priv static final int MESSAGE_SET_MESSAGE
MESSAGE_SET_MESSAGE_TAGback to summary
pack-priv static final int MESSAGE_SET_MESSAGE_TAG
MESSAGE_SET_TYPE_IDback to summary
pack-priv static final int MESSAGE_SET_TYPE_ID
MESSAGE_SET_TYPE_ID_TAGback to summary
pack-priv static final int MESSAGE_SET_TYPE_ID_TAG
TAG_TYPE_BITSback to summary
pack-priv static final int TAG_TYPE_BITS
TAG_TYPE_MASKback to summary
pack-priv static final int TAG_TYPE_MASK
WIRETYPE_END_GROUPback to summary
public static final int WIRETYPE_END_GROUP
WIRETYPE_FIXED32back to summary
public static final int WIRETYPE_FIXED32
WIRETYPE_FIXED64back to summary
public static final int WIRETYPE_FIXED64
WIRETYPE_LENGTH_DELIMITEDback to summary
public static final int WIRETYPE_LENGTH_DELIMITED
WIRETYPE_START_GROUPback to summary
public static final int WIRETYPE_START_GROUP
WIRETYPE_VARINTback to summary
public static final int WIRETYPE_VARINT

Constructor Detail

WireFormatback to summary
private WireFormat()

Method Detail

getTagFieldNumberback to summary
public static int getTagFieldNumber(final int tag)

Given a tag value, determines the field number (the upper 29 bits).

getTagWireTypeback to summary
public static int getTagWireType(final int tag)

Given a tag value, determines the wire type (the lower 3 bits).

makeTagback to summary
pack-priv static int makeTag(final int fieldNumber, final int wireType)

Makes a tag value given a field number and wire type.

readPrimitiveFieldback to summary
pack-priv static Object readPrimitiveField(CodedInputStream input, WireFormat.FieldType type, WireFormat.Utf8Validation utf8Validation) throws IOException

Read a field of any primitive type for immutable messages from a CodedInputStream. Enums, groups, and embedded messages are not handled by this method.

Parameters
input:CodedInputStream

The stream from which to read.

type:WireFormat.FieldType

Declared type of the field.

utf8Validation:WireFormat.Utf8Validation

Different string UTF8 validation level for handling string fields.

Returns:Object

An object representing the field's value, of the exact type which would be returned by Message#getField(Descriptors.FieldDescriptor) for this field.

com.google.protobuf back to summary

public sealed Enum WireFormat.FieldType

extends Enum<WireFormat.FieldType>
Class Inheritance
Lite equivalent to Descriptors.FieldDescriptor.Type. This is only here to support the lite runtime and should not be used by users.

Field Summary

Modifier and TypeField and Description
public static final WireFormat.FieldType
BOOL

public static final WireFormat.FieldType
BYTES

public static final WireFormat.FieldType
DOUBLE

public static final WireFormat.FieldType
ENUM

public static final WireFormat.FieldType
FIXED32

public static final WireFormat.FieldType
FIXED64

public static final WireFormat.FieldType
FLOAT

public static final WireFormat.FieldType
GROUP

public static final WireFormat.FieldType
INT32

public static final WireFormat.FieldType
INT64

private final WireFormat.JavaType
javaType

public static final WireFormat.FieldType
MESSAGE

public static final WireFormat.FieldType
SFIXED32

public static final WireFormat.FieldType
SFIXED64

public static final WireFormat.FieldType
SINT32

public static final WireFormat.FieldType
SINT64

public static final WireFormat.FieldType
STRING

public static final WireFormat.FieldType
UINT32

public static final WireFormat.FieldType
UINT64

private final int
wireType

Constructor Summary

AccessConstructor and Description
private
FieldType(final WireFormat.JavaType javaType, final int wireType)

Method Summary

Modifier and TypeMethod and Description
public WireFormat.JavaType
getJavaType()

public int
getWireType()

public boolean
isPackable()

public static WireFormat.FieldType
valueOf(String name)

public static WireFormat.FieldType[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

BOOLback to summary
public static final WireFormat.FieldType BOOL
BYTESback to summary
public static final WireFormat.FieldType BYTES
DOUBLEback to summary
public static final WireFormat.FieldType DOUBLE
ENUMback to summary
public static final WireFormat.FieldType ENUM
FIXED32back to summary
public static final WireFormat.FieldType FIXED32
FIXED64back to summary
public static final WireFormat.FieldType FIXED64
FLOATback to summary
public static final WireFormat.FieldType FLOAT
GROUPback to summary
public static final WireFormat.FieldType GROUP
INT32back to summary
public static final WireFormat.FieldType INT32
INT64back to summary
public static final WireFormat.FieldType INT64
javaTypeback to summary
private final WireFormat.JavaType javaType
MESSAGEback to summary
public static final WireFormat.FieldType MESSAGE
SFIXED32back to summary
public static final WireFormat.FieldType SFIXED32
SFIXED64back to summary
public static final WireFormat.FieldType SFIXED64
SINT32back to summary
public static final WireFormat.FieldType SINT32
SINT64back to summary
public static final WireFormat.FieldType SINT64
STRINGback to summary
public static final WireFormat.FieldType STRING
UINT32back to summary
public static final WireFormat.FieldType UINT32
UINT64back to summary
public static final WireFormat.FieldType UINT64
wireTypeback to summary
private final int wireType

Constructor Detail

FieldTypeback to summary
private FieldType(final WireFormat.JavaType javaType, final int wireType)

Method Detail

getJavaTypeback to summary
public WireFormat.JavaType getJavaType()
getWireTypeback to summary
public int getWireType()
isPackableback to summary
public boolean isPackable()
valueOfback to summary
public static WireFormat.FieldType valueOf(String name)
valuesback to summary
public static WireFormat.FieldType[] values()
com.google.protobuf back to summary

public final Enum WireFormat.JavaType

extends Enum<WireFormat.JavaType>
Class Inheritance
Lite equivalent to Descriptors.FieldDescriptor.JavaType. This is only here to support the lite runtime and should not be used by users.

Field Summary

Modifier and TypeField and Description
public static final WireFormat.JavaType
BOOLEAN

public static final WireFormat.JavaType
BYTE_STRING

private final Object
defaultDefault

public static final WireFormat.JavaType
DOUBLE

public static final WireFormat.JavaType
ENUM

public static final WireFormat.JavaType
FLOAT

public static final WireFormat.JavaType
INT

public static final WireFormat.JavaType
LONG

public static final WireFormat.JavaType
MESSAGE

public static final WireFormat.JavaType
STRING

Constructor Summary

AccessConstructor and Description
private
JavaType(final Object defaultDefault)

Method Summary

Modifier and TypeMethod and Description
pack-priv Object
getDefaultDefault()

The default default value for fields of this type, if it's a primitive type.

public static WireFormat.JavaType
valueOf(String name)

public static WireFormat.JavaType[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

BOOLEANback to summary
public static final WireFormat.JavaType BOOLEAN
BYTE_STRINGback to summary
public static final WireFormat.JavaType BYTE_STRING
defaultDefaultback to summary
private final Object defaultDefault
DOUBLEback to summary
public static final WireFormat.JavaType DOUBLE
ENUMback to summary
public static final WireFormat.JavaType ENUM
FLOATback to summary
public static final WireFormat.JavaType FLOAT
INTback to summary
public static final WireFormat.JavaType INT
LONGback to summary
public static final WireFormat.JavaType LONG
MESSAGEback to summary
public static final WireFormat.JavaType MESSAGE
STRINGback to summary
public static final WireFormat.JavaType STRING

Constructor Detail

JavaTypeback to summary
private JavaType(final Object defaultDefault)

Method Detail

getDefaultDefaultback to summary
pack-priv Object getDefaultDefault()

The default default value for fields of this type, if it's a primitive type.

valueOfback to summary
public static WireFormat.JavaType valueOf(String name)
valuesback to summary
public static WireFormat.JavaType[] values()
com.google.protobuf back to summary

pack-priv sealed Enum WireFormat.Utf8Validation

extends Enum<WireFormat.Utf8Validation>
Class Inheritance
Validation level for handling incoming string field data which potentially contain non-UTF8 bytes.

Field Summary

Modifier and TypeField and Description
public static final WireFormat.Utf8Validation
LAZY

Keep data as ByteString; validation/conversion to String is lazy.

public static final WireFormat.Utf8Validation
LOOSE

Eagerly parses to String; silently accepts invalid UTF8 bytes.

public static final WireFormat.Utf8Validation
STRICT

Eagerly parses to String; throws an IOException on invalid bytes.

Constructor Summary

AccessConstructor and Description
private
Utf8Validation()

Method Summary

Modifier and TypeMethod and Description
pack-priv abstract Object
readString(CodedInputStream input)

Read a string field from the input with the proper UTF8 validation.

public static WireFormat.Utf8Validation
valueOf(String name)

public static WireFormat.Utf8Validation[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

LAZYback to summary
public static final WireFormat.Utf8Validation LAZY

Keep data as ByteString; validation/conversion to String is lazy.

LOOSEback to summary
public static final WireFormat.Utf8Validation LOOSE

Eagerly parses to String; silently accepts invalid UTF8 bytes.

STRICTback to summary
public static final WireFormat.Utf8Validation STRICT

Eagerly parses to String; throws an IOException on invalid bytes.

Constructor Detail

Utf8Validationback to summary
private Utf8Validation()

Method Detail

readStringback to summary
pack-priv abstract Object readString(CodedInputStream input) throws IOException

Read a string field from the input with the proper UTF8 validation.

valueOfback to summary
public static WireFormat.Utf8Validation valueOf(String name)
valuesback to summary
public static WireFormat.Utf8Validation[] values()