webkit  2cdf99a9e3038c7e01b3c37e8ad903ecbe5eecf1
https://github.com/WebKit/webkit
Classes | Static Public Member Functions | Static Public Attributes | List of all members
com.google.protobuf.Internal Class Reference

Classes

interface  BooleanList
 
interface  DoubleList
 
interface  EnumLite
 
interface  EnumLiteMap
 
interface  FloatList
 
interface  IntList
 
class  ListAdapter
 
interface  LongList
 
class  MapAdapter
 
interface  ProtobufList
 

Static Public Member Functions

static String stringDefaultValue (String bytes)
 
static ByteString bytesDefaultValue (String bytes)
 
static byte [] byteArrayDefaultValue (String bytes)
 
static ByteBuffer byteBufferDefaultValue (String bytes)
 
static ByteBuffer copyByteBuffer (ByteBuffer source)
 
static boolean isValidUtf8 (ByteString byteString)
 
static boolean isValidUtf8 (byte[] byteArray)
 
static byte [] toByteArray (String value)
 
static String toStringUtf8 (byte[] bytes)
 
static int hashLong (long n)
 
static int hashBoolean (boolean b)
 
static int hashEnum (EnumLite e)
 
static int hashEnumList (List<? extends EnumLite > list)
 
static boolean equals (List< byte[]> a, List< byte[]> b)
 
static int hashCode (List< byte[]> list)
 
static int hashCode (byte[] bytes)
 
static boolean equalsByteBuffer (ByteBuffer a, ByteBuffer b)
 
static boolean equalsByteBuffer (List< ByteBuffer > a, List< ByteBuffer > b)
 
static int hashCodeByteBuffer (List< ByteBuffer > list)
 
static int hashCodeByteBuffer (ByteBuffer bytes)
 
static< T extends MessageLite > T getDefaultInstance (Class< T > clazz)
 

Static Public Attributes

static final byte [] EMPTY_BYTE_ARRAY = new byte[0]
 
static final ByteBuffer EMPTY_BYTE_BUFFER
 
static final CodedInputStream EMPTY_CODED_INPUT_STREAM
 

Detailed Description

The classes contained within are used internally by the Protocol Buffer library and generated message implementations. They are public only because those generated messages do not reside in the

protobuf

package. Others should not use this class directly.

Author
kento.nosp@m.n@go.nosp@m.ogle..nosp@m.com (Kenton Varda)

Member Function Documentation

◆ byteArrayDefaultValue()

static byte [] com.google.protobuf.Internal.byteArrayDefaultValue ( String  bytes)
inlinestatic

Helper called by generated code to construct default values for bytes fields.

This is like bytesDefaultValue, but returns a byte array.

◆ byteBufferDefaultValue()

static ByteBuffer com.google.protobuf.Internal.byteBufferDefaultValue ( String  bytes)
inlinestatic

Helper called by generated code to construct default values for bytes fields.

This is like bytesDefaultValue, but returns a ByteBuffer.

◆ bytesDefaultValue()

static ByteString com.google.protobuf.Internal.bytesDefaultValue ( String  bytes)
inlinestatic

Helper called by generated code to construct default values for bytes fields.

This is a lot like stringDefaultValue, but for bytes fields. In this case we only need the second of the two hacks – allowing us to embed raw bytes as a string literal with ISO-8859-1 encoding.

◆ copyByteBuffer()

static ByteBuffer com.google.protobuf.Internal.copyByteBuffer ( ByteBuffer  source)
inlinestatic

Create a new ByteBuffer and copy all the content of

source

ByteBuffer to the new ByteBuffer. The new ByteBuffer's limit and capacity will be source.capacity(), and its position will be 0. Note that the state of

source

ByteBuffer won't be changed.

◆ equals()

static boolean com.google.protobuf.Internal.equals ( List< byte[]>  a,
List< byte[]>  b 
)
inlinestatic

Helper method for implementing Message#equals(Object) for bytes field.

◆ equalsByteBuffer() [1/2]

static boolean com.google.protobuf.Internal.equalsByteBuffer ( ByteBuffer  a,
ByteBuffer  b 
)
inlinestatic

Helper method for implementing Message#equals(Object) for bytes field.

◆ equalsByteBuffer() [2/2]

static boolean com.google.protobuf.Internal.equalsByteBuffer ( List< ByteBuffer >  a,
List< ByteBuffer >  b 
)
inlinestatic

Helper method for implementing Message#equals(Object) for bytes field.

◆ getDefaultInstance()

static <T extends MessageLite> T com.google.protobuf.Internal.getDefaultInstance ( Class< T >  clazz)
inlinestatic

◆ hashBoolean()

static int com.google.protobuf.Internal.hashBoolean ( boolean  b)
inlinestatic

Helper method for implementing Message#hashCode() for booleans.

See also
Boolean::hashCode()

◆ hashCode() [1/2]

static int com.google.protobuf.Internal.hashCode ( List< byte[]>  list)
inlinestatic

Helper method for implementing Message#hashCode() for bytes field.

◆ hashCode() [2/2]

static int com.google.protobuf.Internal.hashCode ( byte []  bytes)
inlinestatic

Helper method for implementing Message#hashCode() for bytes field.

◆ hashCodeByteBuffer() [1/2]

static int com.google.protobuf.Internal.hashCodeByteBuffer ( List< ByteBuffer >  list)
inlinestatic

Helper method for implementing Message#hashCode() for bytes field.

◆ hashCodeByteBuffer() [2/2]

static int com.google.protobuf.Internal.hashCodeByteBuffer ( ByteBuffer  bytes)
inlinestatic

Helper method for implementing Message#hashCode() for bytes field.

◆ hashEnum()

static int com.google.protobuf.Internal.hashEnum ( EnumLite  e)
inlinestatic

Helper method for implementing Message#hashCode() for enums.

This is needed because java.lang.Enum#hashCode() is final, but we need to use the field number as the hash code to ensure compatibility between statically and dynamically generated enum objects.

◆ hashEnumList()

static int com.google.protobuf.Internal.hashEnumList ( List<? extends EnumLite >  list)
inlinestatic

Helper method for implementing Message#hashCode() for enum lists.

◆ hashLong()

static int com.google.protobuf.Internal.hashLong ( long  n)
inlinestatic

Helper method for implementing Message#hashCode() for longs.

See also
Long::hashCode()

◆ isValidUtf8() [1/2]

static boolean com.google.protobuf.Internal.isValidUtf8 ( ByteString  byteString)
inlinestatic

Helper called by generated code to determine if a byte array is a valid UTF-8 encoded string such that the original bytes can be converted to a String object and then back to a byte array round tripping the bytes without loss. More precisely, returns

true

whenever: 

Arrays.equals(byteString.toByteArray(),
    new String(byteString.toByteArray(), "UTF-8").getBytes("UTF-8"))

This method rejects "overlong" byte sequences, as well as 3-byte sequences that would map to a surrogate character, in accordance with the restricted definition of UTF-8 introduced in Unicode 3.1. Note that the UTF-8 decoder included in Oracle's JDK has been modified to also reject "overlong" byte sequences, but currently (2011) still accepts 3-byte surrogate character byte sequences.

See the Unicode Standard,
Table 3-6. UTF-8 Bit Distribution,
Table 3-7. Well Formed UTF-8 Byte Sequences.

As of 2011-02, this method simply returns the result of ByteString#isValidUtf8(). Calling that method directly is preferred.

Parameters
byteStringthe string to check
Returns
whether the byte array is round trippable

◆ isValidUtf8() [2/2]

static boolean com.google.protobuf.Internal.isValidUtf8 ( byte []  byteArray)
inlinestatic

Like isValidUtf8(ByteString) but for byte arrays.

◆ stringDefaultValue()

static String com.google.protobuf.Internal.stringDefaultValue ( String  bytes)
inlinestatic

Helper called by generated code to construct default values for string fields.

The protocol compiler does not actually contain a UTF-8 decoder – it just pushes UTF-8-encoded text around without touching it. The one place where this presents a problem is when generating Java string literals. Unicode characters in the string literal would normally need to be encoded using a Unicode escape sequence, which would require decoding them. To get around this, protoc instead embeds the UTF-8 bytes into the generated code and leaves it to the runtime library to decode them.

It gets worse, though. If protoc just generated a byte array, like: new byte[] {0x12, 0x34, 0x56, 0x78} Java actually generates code which allocates an array and then fills in each value. This is much less efficient than just embedding the bytes directly into the bytecode. To get around this, we need another work-around. String literals are embedded directly, so protoc actually generates a string literal corresponding to the bytes. The easiest way to do this is to use the ISO-8859-1 character set, which corresponds to the first 256 characters of the Unicode range. Protoc can then use good old CEscape to generate the string.

So we have a string literal which represents a set of bytes which represents another string. This function – stringDefaultValue – converts from the generated string to the string we actually want. The generated code calls this automatically.

◆ toByteArray()

static byte [] com.google.protobuf.Internal.toByteArray ( String  value)
inlinestatic

Helper method to get the UTF-8 bytes of a string.

◆ toStringUtf8()

static String com.google.protobuf.Internal.toStringUtf8 ( byte []  bytes)
inlinestatic

Helper method to convert a byte array to a string using UTF-8 encoding.

Member Data Documentation

◆ EMPTY_BYTE_ARRAY

final byte [] com.google.protobuf.Internal.EMPTY_BYTE_ARRAY = new byte[0]
static

An empty byte array constant used in generated code.

◆ EMPTY_BYTE_BUFFER

final ByteBuffer com.google.protobuf.Internal.EMPTY_BYTE_BUFFER
static
Initial value:
=
ByteBuffer.wrap(EMPTY_BYTE_ARRAY)

An empty byte array constant used in generated code.

◆ EMPTY_CODED_INPUT_STREAM

final CodedInputStream com.google.protobuf.Internal.EMPTY_CODED_INPUT_STREAM
static
Initial value:
=
CodedInputStream.newInstance(EMPTY_BYTE_ARRAY)

An empty coded input stream constant used in generated code.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.13