Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge "Make ProtoOutputStream public"

Browse Source
This commit is contained in:
Mike Ma
2020-01-22 18:14:00 +00:00
committed by Gerrit Code Review
parent 9222283997 5f0652fc07
commit 566f8f0195
6 changed files with 565 additions and 274 deletions
Download Patch File Download Diff File Expand all files Collapse all files

65
api/current.txt
View File

@@ -49568,6 +49568,71 @@ package android.util {
}
package android.util.proto {
public final class ProtoOutputStream {
ctor public ProtoOutputStream();
ctor public ProtoOutputStream(int);
ctor public ProtoOutputStream(@NonNull java.io.OutputStream);
method public static int checkFieldId(long, long);
method public void dump(@NonNull String);
method public void end(long);
method public void flush();
method @NonNull public byte[] getBytes();
method @Nullable public static String getFieldCountString(long);
method @NonNull public static String getFieldIdString(long);
method @Nullable public static String getFieldTypeString(long);
method public int getRawSize();
method @Nullable public static String getWireTypeString(int);
method public static long makeFieldId(int, long);
method public static long makeToken(int, boolean, int, int, int);
method public long start(long);
method @NonNull public static String token2String(long);
method public void write(long, double);
method public void write(long, float);
method public void write(long, int);
method public void write(long, long);
method public void write(long, boolean);
method public void write(long, @Nullable String);
method public void write(long, @Nullable byte[]);
method public void writeTag(int, int);
field public static final long FIELD_COUNT_MASK = 16492674416640L; // 0xf0000000000L
field public static final long FIELD_COUNT_PACKED = 5497558138880L; // 0x50000000000L
field public static final long FIELD_COUNT_REPEATED = 2199023255552L; // 0x20000000000L
field public static final int FIELD_COUNT_SHIFT = 40; // 0x28
field public static final long FIELD_COUNT_SINGLE = 1099511627776L; // 0x10000000000L
field public static final long FIELD_COUNT_UNKNOWN = 0L; // 0x0L
field public static final int FIELD_ID_SHIFT = 3; // 0x3
field public static final long FIELD_TYPE_BOOL = 34359738368L; // 0x800000000L
field public static final long FIELD_TYPE_BYTES = 51539607552L; // 0xc00000000L
field public static final long FIELD_TYPE_DOUBLE = 4294967296L; // 0x100000000L
field public static final long FIELD_TYPE_ENUM = 60129542144L; // 0xe00000000L
field public static final long FIELD_TYPE_FIXED32 = 30064771072L; // 0x700000000L
field public static final long FIELD_TYPE_FIXED64 = 25769803776L; // 0x600000000L
field public static final long FIELD_TYPE_FLOAT = 8589934592L; // 0x200000000L
field public static final long FIELD_TYPE_INT32 = 21474836480L; // 0x500000000L
field public static final long FIELD_TYPE_INT64 = 12884901888L; // 0x300000000L
field public static final long FIELD_TYPE_MASK = 1095216660480L; // 0xff00000000L
field public static final long FIELD_TYPE_MESSAGE = 47244640256L; // 0xb00000000L
field public static final long FIELD_TYPE_SFIXED32 = 64424509440L; // 0xf00000000L
field public static final long FIELD_TYPE_SFIXED64 = 68719476736L; // 0x1000000000L
field public static final int FIELD_TYPE_SHIFT = 32; // 0x20
field public static final long FIELD_TYPE_SINT32 = 73014444032L; // 0x1100000000L
field public static final long FIELD_TYPE_SINT64 = 77309411328L; // 0x1200000000L
field public static final long FIELD_TYPE_STRING = 38654705664L; // 0x900000000L
field public static final long FIELD_TYPE_UINT32 = 55834574848L; // 0xd00000000L
field public static final long FIELD_TYPE_UINT64 = 17179869184L; // 0x400000000L
field public static final int WIRE_TYPE_END_GROUP = 4; // 0x4
field public static final int WIRE_TYPE_FIXED32 = 5; // 0x5
field public static final int WIRE_TYPE_FIXED64 = 1; // 0x1
field public static final int WIRE_TYPE_LENGTH_DELIMITED = 2; // 0x2
field public static final int WIRE_TYPE_MASK = 7; // 0x7
field public static final int WIRE_TYPE_START_GROUP = 3; // 0x3
field public static final int WIRE_TYPE_VARINT = 0; // 0x0
}
}
package android.view {
public abstract class AbsSavedState implements android.os.Parcelable {

128
api/test-current.txt
View File

@@ -4129,138 +4129,10 @@ package android.util.proto {
method public void writeRawZigZag64(long);
}
public final class ProtoOutputStream extends android.util.proto.ProtoStream {
ctor public ProtoOutputStream();
ctor public ProtoOutputStream(int);
ctor public ProtoOutputStream(java.io.OutputStream);
ctor public ProtoOutputStream(java.io.FileDescriptor);
method public static int checkFieldId(long, long);
method public void dump(String);
method public void end(long);
method @Deprecated public void endObject(long);
method @Deprecated public void endRepeatedObject(long);
method public void flush();
method public byte[] getBytes();
method public int getRawSize();
method public static long makeFieldId(int, long);
method public long start(long);
method @Deprecated public long startObject(long);
method @Deprecated public long startRepeatedObject(long);
method public void write(long, double);
method public void write(long, float);
method public void write(long, int);
method public void write(long, long);
method public void write(long, boolean);
method public void write(long, String);
method public void write(long, byte[]);
method @Deprecated public void writeBool(long, boolean);
method @Deprecated public void writeBytes(long, byte[]);
method @Deprecated public void writeDouble(long, double);
method @Deprecated public void writeEnum(long, int);
method @Deprecated public void writeFixed32(long, int);
method @Deprecated public void writeFixed64(long, long);
method @Deprecated public void writeFloat(long, float);
method @Deprecated public void writeInt32(long, int);
method @Deprecated public void writeInt64(long, long);
method @Deprecated public void writeObject(long, byte[]);
method @Deprecated public void writePackedBool(long, boolean[]);
method @Deprecated public void writePackedDouble(long, double[]);
method @Deprecated public void writePackedEnum(long, int[]);
method @Deprecated public void writePackedFixed32(long, int[]);
method @Deprecated public void writePackedFixed64(long, long[]);
method @Deprecated public void writePackedFloat(long, float[]);
method @Deprecated public void writePackedInt32(long, int[]);
method @Deprecated public void writePackedInt64(long, long[]);
method @Deprecated public void writePackedSFixed32(long, int[]);
method @Deprecated public void writePackedSFixed64(long, long[]);
method @Deprecated public void writePackedSInt32(long, int[]);
method @Deprecated public void writePackedSInt64(long, long[]);
method @Deprecated public void writePackedUInt32(long, int[]);
method @Deprecated public void writePackedUInt64(long, long[]);
method @Deprecated public void writeRepeatedBool(long, boolean);
method @Deprecated public void writeRepeatedBytes(long, byte[]);
method @Deprecated public void writeRepeatedDouble(long, double);
method @Deprecated public void writeRepeatedEnum(long, int);
method @Deprecated public void writeRepeatedFixed32(long, int);
method @Deprecated public void writeRepeatedFixed64(long, long);
method @Deprecated public void writeRepeatedFloat(long, float);
method @Deprecated public void writeRepeatedInt32(long, int);
method @Deprecated public void writeRepeatedInt64(long, long);
method @Deprecated public void writeRepeatedObject(long, byte[]);
method @Deprecated public void writeRepeatedSFixed32(long, int);
method @Deprecated public void writeRepeatedSFixed64(long, long);
method @Deprecated public void writeRepeatedSInt32(long, int);
method @Deprecated public void writeRepeatedSInt64(long, long);
method @Deprecated public void writeRepeatedString(long, String);
method @Deprecated public void writeRepeatedUInt32(long, int);
method @Deprecated public void writeRepeatedUInt64(long, long);
method @Deprecated public void writeSFixed32(long, int);
method @Deprecated public void writeSFixed64(long, long);
method @Deprecated public void writeSInt32(long, int);
method @Deprecated public void writeSInt64(long, long);
method @Deprecated public void writeString(long, String);
method public void writeTag(int, int);
method @Deprecated public void writeUInt32(long, int);
method @Deprecated public void writeUInt64(long, long);
}
public class ProtoParseException extends java.lang.RuntimeException {
ctor public ProtoParseException(String);
}
public abstract class ProtoStream {
ctor public ProtoStream();
method public static int convertObjectIdToOrdinal(int);
method public static int getDepthFromToken(long);
method public static String getFieldCountString(long);
method public static String getFieldIdString(long);
method public static String getFieldTypeString(long);
method public static int getObjectIdFromToken(long);
method public static int getOffsetFromToken(long);
method public static boolean getRepeatedFromToken(long);
method public static int getTagSizeFromToken(long);
method public static String getWireTypeString(int);
method public static long makeFieldId(int, long);
method public static long makeToken(int, boolean, int, int, int);
method public static String token2String(long);
field public static final long FIELD_COUNT_MASK = 16492674416640L; // 0xf0000000000L
field public static final long FIELD_COUNT_PACKED = 5497558138880L; // 0x50000000000L
field public static final long FIELD_COUNT_REPEATED = 2199023255552L; // 0x20000000000L
field public static final int FIELD_COUNT_SHIFT = 40; // 0x28
field public static final long FIELD_COUNT_SINGLE = 1099511627776L; // 0x10000000000L
field public static final long FIELD_COUNT_UNKNOWN = 0L; // 0x0L
field public static final int FIELD_ID_MASK = -8; // 0xfffffff8
field public static final int FIELD_ID_SHIFT = 3; // 0x3
field public static final long FIELD_TYPE_BOOL = 34359738368L; // 0x800000000L
field public static final long FIELD_TYPE_BYTES = 51539607552L; // 0xc00000000L
field public static final long FIELD_TYPE_DOUBLE = 4294967296L; // 0x100000000L
field public static final long FIELD_TYPE_ENUM = 60129542144L; // 0xe00000000L
field public static final long FIELD_TYPE_FIXED32 = 30064771072L; // 0x700000000L
field public static final long FIELD_TYPE_FIXED64 = 25769803776L; // 0x600000000L
field public static final long FIELD_TYPE_FLOAT = 8589934592L; // 0x200000000L
field public static final long FIELD_TYPE_INT32 = 21474836480L; // 0x500000000L
field public static final long FIELD_TYPE_INT64 = 12884901888L; // 0x300000000L
field public static final long FIELD_TYPE_MASK = 1095216660480L; // 0xff00000000L
field public static final long FIELD_TYPE_MESSAGE = 47244640256L; // 0xb00000000L
field protected static final String[] FIELD_TYPE_NAMES;
field public static final long FIELD_TYPE_SFIXED32 = 64424509440L; // 0xf00000000L
field public static final long FIELD_TYPE_SFIXED64 = 68719476736L; // 0x1000000000L
field public static final int FIELD_TYPE_SHIFT = 32; // 0x20
field public static final long FIELD_TYPE_SINT32 = 73014444032L; // 0x1100000000L
field public static final long FIELD_TYPE_SINT64 = 77309411328L; // 0x1200000000L
field public static final long FIELD_TYPE_STRING = 38654705664L; // 0x900000000L
field public static final long FIELD_TYPE_UINT32 = 55834574848L; // 0xd00000000L
field public static final long FIELD_TYPE_UINT64 = 17179869184L; // 0x400000000L
field public static final long FIELD_TYPE_UNKNOWN = 0L; // 0x0L
field public static final int WIRE_TYPE_END_GROUP = 4; // 0x4
field public static final int WIRE_TYPE_FIXED32 = 5; // 0x5
field public static final int WIRE_TYPE_FIXED64 = 1; // 0x1
field public static final int WIRE_TYPE_LENGTH_DELIMITED = 2; // 0x2
field public static final int WIRE_TYPE_MASK = 7; // 0x7
field public static final int WIRE_TYPE_START_GROUP = 3; // 0x3
field public static final int WIRE_TYPE_VARINT = 0; // 0x0
}
public class WireTypeMismatchException extends android.util.proto.ProtoParseException {
ctor public WireTypeMismatchException(String);
}

316
core/java/android/util/proto/ProtoOutputStream.java
View File

@@ -16,7 +16,8 @@
package android.util.proto;
import android.annotation.TestApi;
import android.annotation.NonNull;
import android.annotation.Nullable;
import android.util.Log;
import java.io.FileDescriptor;
@@ -28,19 +29,23 @@ import java.io.UnsupportedEncodingException;
/**
* Class to write to a protobuf stream.
*
* Each write method takes an ID code from the protoc generated classes
* and the value to write. To make a nested object, call #start
* and then #end when you are done.
* <p>
* This API is not as convenient or type safe as the standard protobuf
* classes. If possible, the best recommended library is to use protobuf lite.
* However, in environements (such as the Android platform itself), a
* more memory efficient version is necessary.
*
* The ID codes have type information embedded into them, so if you call
* the incorrect function you will get an IllegalArgumentException.
* <p>Each write method takes an ID code from the protoc generated classes
* and the value to write. To make a nested object, call {@link #start(long)}
* and then {@link #end(long)} when you are done.
*
* To retrieve the encoded protobuf stream, call getBytes().
* <p>The ID codes have type information embedded into them, so if you call
* the incorrect function you will get an {@link IllegalArgumentException}.
*
* <p>To retrieve the encoded protobuf stream, call {@link #getBytes()}.
*
* TODO: Add a constructor that takes an OutputStream and write to that
* stream as the top-level objects are finished.
*
* @hide
*/
/* IMPLEMENTATION NOTES
@@ -99,7 +104,6 @@ import java.io.UnsupportedEncodingException;
* correctly matched pairs of #start and #end calls, and issue
* errors if they are not matched.
*/
@TestApi
public final class ProtoOutputStream extends ProtoStream {
/**
* @hide
@@ -124,7 +128,9 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* An ID given to objects and returned in the token from startObject
* and stored in the buffer until endObject is called, where the two
* are checked. Starts at -1 and becomes more negative, so the values
* are checked.
*
* <p>Starts at -1 and becomes more negative, so the values
* aren't likely to alias with the size it will be overwritten with,
* which tend to be small, and we will be more likely to catch when
* the caller of endObject uses a stale token that they didn't intend
@@ -133,8 +139,9 @@ public final class ProtoOutputStream extends ProtoStream {
private int mNextObjectId = -1;
/**
* The object token we are expecting in endObject. If another call to
* startObject happens, this is written to that location, which gives
* The object token we are expecting in endObject.
*
* <p>If another call to startObject happens, this is written to that location, which gives
* us a stack, stored in the space for the as-yet unused size fields.
*/
private long mExpectedObjectToken;
@@ -151,39 +158,45 @@ public final class ProtoOutputStream extends ProtoStream {
private boolean mCompacted;
/**
* Construct a ProtoOutputStream with the default chunk size.
* Construct a {@link ProtoOutputStream} with the default chunk size.
*
* <p>This is for an in-memory proto. The caller should use {@link #getBytes()} for the result.
*/
public ProtoOutputStream() {
this(0);
}
/**
* Construct a ProtoOutputStream with the given chunk size.
* Construct a {@link ProtoOutputStream with the given chunk size.
*
* <p>This is for an in-memory proto. The caller should use {@link #getBytes()} for the result.
*/
public ProtoOutputStream(int chunkSize) {
mBuffer = new EncodedBuffer(chunkSize);
}
/**
* Construct a ProtoOutputStream that sits on top of an OutputStream.
* @more
* The {@link #flush() flush()} method must be called when done writing
* to flush any remanining data, althought data *may* be written at intermediate
* Construct a {@link ProtoOutputStream} that sits on top of an {@link OutputStream}.
*
* <p>The {@link #flush()} method must be called when done writing
* to flush any remaining data, although data *may* be written at intermediate
* points within the writing as well.
*/
public ProtoOutputStream(OutputStream stream) {
public ProtoOutputStream(@NonNull OutputStream stream) {
this();
mStream = stream;
}
/**
* Construct a ProtoOutputStream that sits on top of a FileDescriptor.
* @more
* The {@link #flush() flush()} method must be called when done writing
* to flush any remanining data, althought data *may* be written at intermediate
* Construct a {@link ProtoOutputStream} that sits on top of a {@link FileDescriptor}.
*
* <p>The {@link #flush()} method must be called when done writing
* to flush any remaining data, although data *may* be written at intermediate
* points within the writing as well.
*
* @hide
*/
public ProtoOutputStream(FileDescriptor fd) {
public ProtoOutputStream(@NonNull FileDescriptor fd) {
this(new FileOutputStream(fd));
}
@@ -202,7 +215,7 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a value for the given fieldId.
*
* Will automatically convert for the following field types, and
* <p>Will automatically convert for the following field types, and
* throw an exception for others: double, float, int32, int64, uint32, uint64,
* sint32, sint64, fixed32, fixed64, sfixed32, sfixed64, bool, enum.
*
@@ -337,7 +350,7 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a value for the given fieldId.
*
* Will automatically convert for the following field types, and
* <p>Will automatically convert for the following field types, and
* throw an exception for others: double, float, int32, int64, uint32, uint64,
* sint32, sint64, fixed32, fixed64, sfixed32, sfixed64, bool, enum.
*
@@ -472,7 +485,7 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a value for the given fieldId.
*
* Will automatically convert for the following field types, and
* <p>Will automatically convert for the following field types, and
* throw an exception for others: double, float, int32, int64, uint32, uint64,
* sint32, sint64, fixed32, fixed64, sfixed32, sfixed64, bool, enum.
*
@@ -607,7 +620,7 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a value for the given fieldId.
*
* Will automatically convert for the following field types, and
* <p>Will automatically convert for the following field types, and
* throw an exception for others: double, float, int32, int64, uint32, uint64,
* sint32, sint64, fixed32, fixed64, sfixed32, sfixed64, bool, enum.
*
@@ -742,7 +755,7 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a boolean value for the given fieldId.
*
* If the field is not a bool field, an exception will be thrown.
* <p>If the field is not a bool field, an {@link IllegalStateException} will be thrown.
*
* @param fieldId The field identifier constant from the generated class.
* @param val The value.
@@ -771,12 +784,12 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a string value for the given fieldId.
*
* If the field is not a string field, an exception will be thrown.
* <p>If the field is not a string field, an exception will be thrown.
*
* @param fieldId The field identifier constant from the generated class.
* @param val The value.
*/
public void write(long fieldId, String val) {
public void write(long fieldId, @Nullable String val) {
assertNotCompacted();
final int id = (int)fieldId;
@@ -800,12 +813,12 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a byte[] value for the given fieldId.
*
* If the field is not a bytes or object field, an exception will be thrown.
* <p>If the field is not a bytes or object field, an exception will be thrown.
*
* @param fieldId The field identifier constant from the generated class.
* @param val The value.
*/
public void write(long fieldId, byte[] val) {
public void write(long fieldId, @Nullable byte[] val) {
assertNotCompacted();
final int id = (int)fieldId;
@@ -836,6 +849,9 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Start a sub object.
*
* @param fieldId The field identifier constant from the generated class.
* @return The token to call {@link #end(long)} with.
*/
public long start(long fieldId) {
assertNotCompacted();
@@ -855,6 +871,8 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* End the object started by start() that returned token.
*
* @param token The token returned from {@link #start(long)}
*/
public void end(long token) {
endObjectImpl(token, getRepeatedFromToken(token));
@@ -870,7 +888,8 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a single proto "double" type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, double)} instead.
* @hide
*/
@Deprecated
public void writeDouble(long fieldId, double val) {
@@ -890,7 +909,8 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a single repeated proto "double" type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, double)} instead.
* @hide
*/
@Deprecated
public void writeRepeatedDouble(long fieldId, double val) {
@@ -908,10 +928,11 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a list of packed proto "double" type field values.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, double)} instead.
* @hide
*/
@Deprecated
public void writePackedDouble(long fieldId, double[] val) {
public void writePackedDouble(long fieldId, @Nullable double[] val) {
assertNotCompacted();
final int id = checkFieldId(fieldId, FIELD_COUNT_PACKED | FIELD_TYPE_DOUBLE);
@@ -934,7 +955,8 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a single proto "float" type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, float)} instead.
* @hide
*/
@Deprecated
public void writeFloat(long fieldId, float val) {
@@ -954,7 +976,8 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a single repeated proto "float" type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, float)} instead.
* @hide
*/
@Deprecated
public void writeRepeatedFloat(long fieldId, float val) {
@@ -972,10 +995,11 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a list of packed proto "float" type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, float)} instead.
* @hide
*/
@Deprecated
public void writePackedFloat(long fieldId, float[] val) {
public void writePackedFloat(long fieldId, @Nullable float[] val) {
assertNotCompacted();
final int id = checkFieldId(fieldId, FIELD_COUNT_PACKED | FIELD_TYPE_FLOAT);
@@ -999,7 +1023,7 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Writes a java int as an usigned varint.
*
* The unadorned int32 type in protobuf is unfortunate because it
* <p>The unadorned int32 type in protobuf is unfortunate because it
* is stored in memory as a signed value, but encodes as unsigned
* varints, which are formally always longs. So here, we encode
* negative values as 64 bits, which will get the sign-extension,
@@ -1017,11 +1041,12 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a single proto "int32" type field value.
*
* Note that these are stored in memory as signed values and written as unsigned
* <p>Note that these are stored in memory as signed values and written as unsigned
* varints, which if negative, are 10 bytes long. If you know the data is likely
* to be negative, use "sint32".
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, int)} instead.
* @hide
*/
@Deprecated
public void writeInt32(long fieldId, int val) {
@@ -1041,11 +1066,12 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a single repeated proto "int32" type field value.
*
* Note that these are stored in memory as signed values and written as unsigned
* <p>Note that these are stored in memory as signed values and written as unsigned
* varints, which if negative, are 10 bytes long. If you know the data is likely
* to be negative, use "sint32".
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, int)} instead.
* @hide
*/
@Deprecated
public void writeRepeatedInt32(long fieldId, int val) {
@@ -1063,14 +1089,15 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a list of packed proto "int32" type field value.
*
* Note that these are stored in memory as signed values and written as unsigned
* <p>Note that these are stored in memory as signed values and written as unsigned
* varints, which if negative, are 10 bytes long. If you know the data is likely
* to be negative, use "sint32".
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, int)} instead.
* @hide
*/
@Deprecated
public void writePackedInt32(long fieldId, int[] val) {
public void writePackedInt32(long fieldId, @Nullable int[] val) {
assertNotCompacted();
final int id = checkFieldId(fieldId, FIELD_COUNT_PACKED | FIELD_TYPE_INT32);
@@ -1099,7 +1126,8 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a single proto "int64" type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, long)} instead.
* @hide
*/
@Deprecated
public void writeInt64(long fieldId, long val) {
@@ -1119,7 +1147,8 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a single repeated proto "int64" type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, long)} instead.
* @hide
*/
@Deprecated
public void writeRepeatedInt64(long fieldId, long val) {
@@ -1137,10 +1166,11 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a list of packed proto "int64" type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, long)} instead.
* @hide
*/
@Deprecated
public void writePackedInt64(long fieldId, long[] val) {
public void writePackedInt64(long fieldId, @Nullable long[] val) {
assertNotCompacted();
final int id = checkFieldId(fieldId, FIELD_COUNT_PACKED | FIELD_TYPE_INT64);
@@ -1168,7 +1198,8 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a single proto "uint32" type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, int)} instead.
* @hide
*/
@Deprecated
public void writeUInt32(long fieldId, int val) {
@@ -1188,7 +1219,8 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a single repeated proto "uint32" type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, int)} instead.
* @hide
*/
@Deprecated
public void writeRepeatedUInt32(long fieldId, int val) {
@@ -1206,10 +1238,11 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a list of packed proto "uint32" type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, int)} instead.
* @hide
*/
@Deprecated
public void writePackedUInt32(long fieldId, int[] val) {
public void writePackedUInt32(long fieldId, @Nullable int[] val) {
assertNotCompacted();
final int id = checkFieldId(fieldId, FIELD_COUNT_PACKED | FIELD_TYPE_UINT32);
@@ -1237,7 +1270,8 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a single proto "uint64" type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, long)} instead.
* @hide
*/
@Deprecated
public void writeUInt64(long fieldId, long val) {
@@ -1257,7 +1291,8 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a single proto "uint64" type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, long)} instead.
* @hide
*/
@Deprecated
public void writeRepeatedUInt64(long fieldId, long val) {
@@ -1275,10 +1310,11 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a single proto "uint64" type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, long)} instead.
* @hide
*/
@Deprecated
public void writePackedUInt64(long fieldId, long[] val) {
public void writePackedUInt64(long fieldId, @Nullable long[] val) {
assertNotCompacted();
final int id = checkFieldId(fieldId, FIELD_COUNT_PACKED | FIELD_TYPE_UINT64);
@@ -1306,7 +1342,8 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a single proto "sint32" type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, int)} instead.
* @hide
*/
@Deprecated
public void writeSInt32(long fieldId, int val) {
@@ -1326,7 +1363,8 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a single repeated proto "sint32" type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, int)} instead.
* @hide
*/
@Deprecated
public void writeRepeatedSInt32(long fieldId, int val) {
@@ -1344,10 +1382,11 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a list of packed proto "sint32" type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, int)} instead.
* @hide
*/
@Deprecated
public void writePackedSInt32(long fieldId, int[] val) {
public void writePackedSInt32(long fieldId, @Nullable int[] val) {
assertNotCompacted();
final int id = checkFieldId(fieldId, FIELD_COUNT_PACKED | FIELD_TYPE_SINT32);
@@ -1375,7 +1414,8 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a single proto "sint64" type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, long)} instead.
* @hide
*/
@Deprecated
public void writeSInt64(long fieldId, long val) {
@@ -1395,7 +1435,8 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a single repeated proto "sint64" type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, long)} instead.
* @hide
*/
@Deprecated
public void writeRepeatedSInt64(long fieldId, long val) {
@@ -1413,10 +1454,11 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a list of packed proto "sint64" type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, long)} instead.
* @hide
*/
@Deprecated
public void writePackedSInt64(long fieldId, long[] val) {
public void writePackedSInt64(long fieldId, @Nullable long[] val) {
assertNotCompacted();
final int id = checkFieldId(fieldId, FIELD_COUNT_PACKED | FIELD_TYPE_SINT64);
@@ -1443,7 +1485,8 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a single proto "fixed32" type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, int)} instead.
* @hide
*/
@Deprecated
public void writeFixed32(long fieldId, int val) {
@@ -1463,7 +1506,8 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a single repeated proto "fixed32" type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, int)} instead.
* @hide
*/
@Deprecated
public void writeRepeatedFixed32(long fieldId, int val) {
@@ -1481,10 +1525,11 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a list of packed proto "fixed32" type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, int)} instead.
* @hide
*/
@Deprecated
public void writePackedFixed32(long fieldId, int[] val) {
public void writePackedFixed32(long fieldId, @Nullable int[] val) {
assertNotCompacted();
final int id = checkFieldId(fieldId, FIELD_COUNT_PACKED | FIELD_TYPE_FIXED32);
@@ -1507,7 +1552,8 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a single proto "fixed64" type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, long)} instead.
* @hide
*/
@Deprecated
public void writeFixed64(long fieldId, long val) {
@@ -1527,7 +1573,8 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a single repeated proto "fixed64" type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, long)} instead.
* @hide
*/
@Deprecated
public void writeRepeatedFixed64(long fieldId, long val) {
@@ -1545,10 +1592,11 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a list of packed proto "fixed64" type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, long)} instead.
* @hide
*/
@Deprecated
public void writePackedFixed64(long fieldId, long[] val) {
public void writePackedFixed64(long fieldId, @Nullable long[] val) {
assertNotCompacted();
final int id = checkFieldId(fieldId, FIELD_COUNT_PACKED | FIELD_TYPE_FIXED64);
@@ -1570,7 +1618,8 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a single proto "sfixed32" type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, int)} instead.
* @hide
*/
@Deprecated
public void writeSFixed32(long fieldId, int val) {
@@ -1590,7 +1639,8 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a single repeated proto "sfixed32" type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, int)} instead.
* @hide
*/
@Deprecated
public void writeRepeatedSFixed32(long fieldId, int val) {
@@ -1608,10 +1658,11 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a list of packed proto "sfixed32" type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, int)} instead.
* @hide
*/
@Deprecated
public void writePackedSFixed32(long fieldId, int[] val) {
public void writePackedSFixed32(long fieldId, @Nullable int[] val) {
assertNotCompacted();
final int id = checkFieldId(fieldId, FIELD_COUNT_PACKED | FIELD_TYPE_SFIXED32);
@@ -1634,7 +1685,8 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a single proto "sfixed64" type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, long)} instead.
* @hide
*/
@Deprecated
public void writeSFixed64(long fieldId, long val) {
@@ -1654,7 +1706,8 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a single repeated proto "sfixed64" type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, long)} instead.
* @hide
*/
@Deprecated
public void writeRepeatedSFixed64(long fieldId, long val) {
@@ -1672,10 +1725,11 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a list of packed proto "sfixed64" type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, long)} instead.
* @hide
*/
@Deprecated
public void writePackedSFixed64(long fieldId, long[] val) {
public void writePackedSFixed64(long fieldId, @Nullable long[] val) {
assertNotCompacted();
final int id = checkFieldId(fieldId, FIELD_COUNT_PACKED | FIELD_TYPE_SFIXED64);
@@ -1698,7 +1752,8 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a single proto "bool" type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, boolean)} instead.
* @hide
*/
@Deprecated
public void writeBool(long fieldId, boolean val) {
@@ -1719,7 +1774,8 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a single repeated proto "bool" type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, boolean)} instead.
* @hide
*/
@Deprecated
public void writeRepeatedBool(long fieldId, boolean val) {
@@ -1737,10 +1793,11 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a list of packed proto "bool" type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, boolean)} instead.
* @hide
*/
@Deprecated
public void writePackedBool(long fieldId, boolean[] val) {
public void writePackedBool(long fieldId, @Nullable boolean[] val) {
assertNotCompacted();
final int id = checkFieldId(fieldId, FIELD_COUNT_PACKED | FIELD_TYPE_BOOL);
@@ -1767,10 +1824,11 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a single proto "string" type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, String)} instead.
* @hide
*/
@Deprecated
public void writeString(long fieldId, String val) {
public void writeString(long fieldId, @Nullable String val) {
assertNotCompacted();
final int id = checkFieldId(fieldId, FIELD_COUNT_SINGLE | FIELD_TYPE_STRING);
@@ -1786,10 +1844,11 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a single repeated proto "string" type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, String)} instead.
* @hide
*/
@Deprecated
public void writeRepeatedString(long fieldId, String val) {
public void writeRepeatedString(long fieldId, @Nullable String val) {
assertNotCompacted();
final int id = checkFieldId(fieldId, FIELD_COUNT_REPEATED | FIELD_TYPE_STRING);
@@ -1828,10 +1887,11 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a single proto "bytes" type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, byte[])} instead.
* @hide
*/
@Deprecated
public void writeBytes(long fieldId, byte[] val) {
public void writeBytes(long fieldId, @Nullable byte[] val) {
assertNotCompacted();
final int id = checkFieldId(fieldId, FIELD_COUNT_SINGLE | FIELD_TYPE_BYTES);
@@ -1848,10 +1908,11 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a single repeated proto "bytes" type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, byte[])} instead.
* @hide
*/
@Deprecated
public void writeRepeatedBytes(long fieldId, byte[] val) {
public void writeRepeatedBytes(long fieldId, @Nullable byte[] val) {
assertNotCompacted();
final int id = checkFieldId(fieldId, FIELD_COUNT_REPEATED | FIELD_TYPE_BYTES);
@@ -1874,7 +1935,8 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a single proto enum type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, int)} instead.
* @hide
*/
@Deprecated
public void writeEnum(long fieldId, int val) {
@@ -1894,7 +1956,8 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a single repeated proto enum type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, int)} instead.
* @hide
*/
@Deprecated
public void writeRepeatedEnum(long fieldId, int val) {
@@ -1912,10 +1975,11 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write a list of packed proto enum type field value.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, int)} instead.
* @hide
*/
@Deprecated
public void writePackedEnum(long fieldId, int[] val) {
public void writePackedEnum(long fieldId, @Nullable int[] val) {
assertNotCompacted();
final int id = checkFieldId(fieldId, FIELD_COUNT_PACKED | FIELD_TYPE_ENUM);
@@ -1940,7 +2004,8 @@ public final class ProtoOutputStream extends ProtoStream {
* Returns a token which should be passed to endObject. Calls to endObject must be
* nested properly.
*
* @deprecated Use #start() instead.
* @deprecated Use {@link #start(long)} instead.
* @hide
*/
@Deprecated
public long startObject(long fieldId) {
@@ -1953,7 +2018,8 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* End a child object. Pass in the token from the correspoinding startObject call.
*
* @deprecated Use #end() instead.
* @deprecated Use {@link #end(long)} instead.
* @hide
*/
@Deprecated
public void endObject(long token) {
@@ -1968,7 +2034,8 @@ public final class ProtoOutputStream extends ProtoStream {
* Returns a token which should be passed to endObject. Calls to endObject must be
* nested properly.
*
* @deprecated Use #start() instead.
* @deprecated Use {@link #start(long)} instead.
* @hide
*/
@Deprecated
public long startRepeatedObject(long fieldId) {
@@ -1981,7 +2048,8 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* End a child object. Pass in the token from the correspoinding startRepeatedObject call.
*
* @deprecated Use #end() instead.
* @deprecated Use {@link #end(long)} instead.
* @hide
*/
@Deprecated
public void endRepeatedObject(long token) {
@@ -2064,12 +2132,13 @@ public final class ProtoOutputStream extends ProtoStream {
}
/**
* Write an object that has already been flattend.
* Write an object that has already been flattened.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, byte[])} instead.
* @hide
*/
@Deprecated
public void writeObject(long fieldId, byte[] value) {
public void writeObject(long fieldId, @Nullable byte[] value) {
assertNotCompacted();
final int id = checkFieldId(fieldId, FIELD_COUNT_SINGLE | FIELD_TYPE_MESSAGE);
@@ -2084,12 +2153,13 @@ public final class ProtoOutputStream extends ProtoStream {
}
/**
* Write an object that has already been flattend.
* Write an object that has already been flattened.
*
* @deprecated Use #write instead.
* @deprecated Use {@link #write(long, byte[])} instead.
* @hide
*/
@Deprecated
public void writeRepeatedObject(long fieldId, byte[] value) {
public void writeRepeatedObject(long fieldId, @Nullable byte[] value) {
assertNotCompacted();
final int id = checkFieldId(fieldId, FIELD_COUNT_REPEATED | FIELD_TYPE_MESSAGE);
@@ -2115,11 +2185,11 @@ public final class ProtoOutputStream extends ProtoStream {
}
/**
* Validates that the fieldId providied is of the type and count from expectedType.
* Validates that the fieldId provided is of the type and count from expectedType.
*
* The type must match exactly to pass this check.
* <p>The type must match exactly to pass this check.
*
* The count must match according to this truth table to pass the check:
* <p>The count must match according to this truth table to pass the check:
*
* expectedFlags
* UNKNOWN SINGLE REPEATED PACKED
@@ -2129,7 +2199,7 @@ public final class ProtoOutputStream extends ProtoStream {
* REPEATED x false true false
* PACKED x false true true
*
* @throws IllegalArgumentException if it is not.
* @throws {@link IllegalArgumentException} if it is not.
*
* @return The raw ID of that field.
*/
@@ -2201,7 +2271,7 @@ public final class ProtoOutputStream extends ProtoStream {
}
/**
* Write a field tage to the stream.
* Write a field tag to the stream.
*/
public void writeTag(int id, int wireType) {
mBuffer.writeRawVarint32((id << FIELD_ID_SHIFT) | wireType);
@@ -2239,10 +2309,10 @@ public final class ProtoOutputStream extends ProtoStream {
* Finish the encoding of the data, and return a byte[] with
* the protobuf formatted data.
*
* After this call, do not call any of the write* functions. The
* <p>After this call, do not call any of the write* functions. The
* behavior is undefined.
*/
public byte[] getBytes() {
public @NonNull byte[] getBytes() {
compactIfNecessary();
return mBuffer.getBytes(mBuffer.getReadableSize());
@@ -2289,7 +2359,7 @@ public final class ProtoOutputStream extends ProtoStream {
}
/**
* First compaction pass. Iterate through the data, and fill in the
* First compaction pass. Iterate through the data, and fill in the
* nested object sizes so the next pass can compact them.
*/
private int editEncodedSize(int rawSize) {
@@ -2416,10 +2486,10 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Write remaining data to the output stream. If there is no output stream,
* this function does nothing. Any currently open objects (i.e. ones that
* have not had endObject called for them will not be written). Whether this
* have not had {@link #end(long)} called for them will not be written). Whether this
* writes objects that are closed if there are remaining open objects is
* undefined (current implementation does not write it, future ones will).
* For now, can either call getBytes() or flush(), but not both.
* For now, can either call {@link #getBytes()} or {@link #flush()}, but not both.
*/
public void flush() {
if (mStream == null) {
@@ -2457,7 +2527,7 @@ public final class ProtoOutputStream extends ProtoStream {
/**
* Dump debugging data about the buffers with the given log tag.
*/
public void dump(String tag) {
public void dump(@NonNull String tag) {
Log.d(tag, mBuffer.getDebugString());
mBuffer.dumpBuffers(tag);
}

322
core/java/android/util/proto/ProtoStream.java
View File

@@ -16,28 +16,104 @@
package android.util.proto;
import android.annotation.TestApi;
import android.annotation.NonNull;
import android.annotation.Nullable;
/**
* Abstract base class for both protobuf streams.
* Base utility class for protobuf streams.
*
* Contains a set of useful constants and methods used by both
* ProtoOutputStream and ProtoInputStream
* Contains a set of constants and methods used in generated code for
* {@link ProtoOutputStream}.
*
* @hide
*/
@TestApi
public abstract class ProtoStream {
public class ProtoStream {
/**
* Number of bits to shift the field number to form a tag.
*
* <pre>
* // Reading a field number from a tag.
* int fieldNumber = tag &gt;&gt;&gt; FIELD_ID_SHIFT;
*
* // Building a tag from a field number and a wire type.
* int tag = (fieldNumber &lt;&lt; FIELD_ID_SHIFT) | wireType;
* </pre>
*
* @see <a href="https://developers.google.com/protocol-buffers/docs/encoding">Protobuf
* Encoding</a>
*/
public static final int FIELD_ID_SHIFT = 3;
/**
* Mask to select the wire type from a tag.
*
* <pre>
* // Reading a wire type from a tag.
* int wireType = tag &amp; WIRE_TYPE_MASK;
*
* // Building a tag from a field number and a wire type.
* int tag = (fieldNumber &lt;&lt; FIELD_ID_SHIFT) | wireType;
* </pre>
*
* @see <a href="https://developers.google.com/protocol-buffers/docs/encoding">Protobuf
* Encoding</a>
*/
public static final int WIRE_TYPE_MASK = (1 << FIELD_ID_SHIFT) - 1;
/**
* Mask to select the field id from a tag.
* @hide (not used by anything, and not actually useful, because you also want
* to shift when you mask the field id).
*/
public static final int FIELD_ID_MASK = ~WIRE_TYPE_MASK;
/**
* Varint wire type code.
*
* @see <a href="https://developers.google.com/protocol-buffers/docs/encoding">Protobuf
* Encoding</a>
*/
public static final int WIRE_TYPE_VARINT = 0;
/**
* Fixed64 wire type code.
*
* @see <a href="https://developers.google.com/protocol-buffers/docs/encoding">Protobuf
* Encoding</a>
*/
public static final int WIRE_TYPE_FIXED64 = 1;
/**
* Length delimited wire type code.
*
* @see <a href="https://developers.google.com/protocol-buffers/docs/encoding">Protobuf
* Encoding</a>
*/
public static final int WIRE_TYPE_LENGTH_DELIMITED = 2;
/**
* Start group wire type code.
*
* @see <a href="https://developers.google.com/protocol-buffers/docs/encoding">Protobuf
* Encoding</a>
*/
public static final int WIRE_TYPE_START_GROUP = 3;
/**
* End group wire type code.
*
* @see <a href="https://developers.google.com/protocol-buffers/docs/encoding">Protobuf
* Encoding</a>
*/
public static final int WIRE_TYPE_END_GROUP = 4;
/**
* Fixed32 wire type code.
*
* @see <a href="https://developers.google.com/protocol-buffers/docs/encoding">Protobuf
* Encoding</a>
*/
public static final int WIRE_TYPE_FIXED32 = 5;
/**
@@ -51,32 +127,147 @@ public abstract class ProtoStream {
*/
public static final long FIELD_TYPE_MASK = 0x0ffL << FIELD_TYPE_SHIFT;
/**
* Not a real wire type.
* @hide
*/
public static final long FIELD_TYPE_UNKNOWN = 0;
/*
* The FIELD_TYPE_ constants are copied from
* external/protobuf/src/google/protobuf/descriptor.h directly, so no
* extra mapping needs to be maintained in this case.
*/
/**
* The types are copied from external/protobuf/src/google/protobuf/descriptor.h directly,
* so no extra mapping needs to be maintained in this case.
* Field type code for double fields. Used to build constants in generated
* code for use with the {@link ProtoOutputStream#write(long, double)
* ProtoOutputStream.write(long, double)} method.
*/
public static final long FIELD_TYPE_DOUBLE = 1L << FIELD_TYPE_SHIFT;
/**
* Field type code for float fields. Used to build constants in generated
* code for use with the {@link ProtoOutputStream#write(long, float)
* ProtoOutputStream.write(long, float)} method.
*/
public static final long FIELD_TYPE_FLOAT = 2L << FIELD_TYPE_SHIFT;
/**
* Field type code for int64 fields. Used to build constants in generated
* code for use with the {@link ProtoOutputStream#write(long, long)
* ProtoOutputStream.write(long, long)} method.
*/
public static final long FIELD_TYPE_INT64 = 3L << FIELD_TYPE_SHIFT;
/**
* Field type code for uint64 fields. Used to build constants in generated
* code for use with the {@link ProtoOutputStream#write(long, long)
* ProtoOutputStream.write(long, long)} method.
*/
public static final long FIELD_TYPE_UINT64 = 4L << FIELD_TYPE_SHIFT;
/**
* Field type code for int32 fields. Used to build constants in generated
* code for use with the {@link ProtoOutputStream#write(long, int)
* ProtoOutputStream.write(long, int)} method.
*/
public static final long FIELD_TYPE_INT32 = 5L << FIELD_TYPE_SHIFT;
/**
* Field type code for fixed64 fields. Used to build constants in generated
* code for use with the {@link ProtoOutputStream#write(long, long)
* ProtoOutputStream.write(long, long)} method.
*/
public static final long FIELD_TYPE_FIXED64 = 6L << FIELD_TYPE_SHIFT;
/**
* Field type code for fixed32 fields. Used to build constants in generated
* code for use with the {@link ProtoOutputStream#write(long, int)
* ProtoOutputStream.write(long, int)} method.
*/
/**
* Field type code for fixed32 fields. Used to build constants in generated
* code for use with the {@link ProtoOutputStream#write(long, int)
* ProtoOutputStream.write(long, int)} method.
*/
public static final long FIELD_TYPE_FIXED32 = 7L << FIELD_TYPE_SHIFT;
/**
* Field type code for bool fields. Used to build constants in generated
* code for use with the {@link ProtoOutputStream#write(long, boolean)
* ProtoOutputStream.write(long, boolean)} method.
*/
public static final long FIELD_TYPE_BOOL = 8L << FIELD_TYPE_SHIFT;
/**
* Field type code for string fields. Used to build constants in generated
* code for use with the {@link ProtoOutputStream#write(long, String)
* ProtoOutputStream.write(long, String)} method.
*/
public static final long FIELD_TYPE_STRING = 9L << FIELD_TYPE_SHIFT;
// public static final long FIELD_TYPE_GROUP = 10L << FIELD_TYPE_SHIFT; // Deprecated.
/**
* Field type code for message fields. Used to build constants in generated
* code for use with the {@link ProtoOutputStream#start(long)
* ProtoOutputStream.start(long)} method.
*/
public static final long FIELD_TYPE_MESSAGE = 11L << FIELD_TYPE_SHIFT;
/**
* Field type code for bytes fields. Used to build constants in generated
* code for use with the {@link ProtoOutputStream#write(long, byte[])
* ProtoOutputStream.write(long, byte[])} method.
*/
public static final long FIELD_TYPE_BYTES = 12L << FIELD_TYPE_SHIFT;
/**
* Field type code for uint32 fields. Used to build constants in generated
* code for use with the {@link ProtoOutputStream#write(long, int)
* ProtoOutputStream.write(long, int)} method.
*/
public static final long FIELD_TYPE_UINT32 = 13L << FIELD_TYPE_SHIFT;
/**
* Field type code for enum fields. Used to build constants in generated
* code for use with the {@link ProtoOutputStream#write(long, int)
* ProtoOutputStream.write(long, int)} method.
*/
public static final long FIELD_TYPE_ENUM = 14L << FIELD_TYPE_SHIFT;
/**
* Field type code for sfixed32 fields. Used to build constants in generated
* code for use with the {@link ProtoOutputStream#write(long, int)
* ProtoOutputStream.write(long, int)} method.
*/
public static final long FIELD_TYPE_SFIXED32 = 15L << FIELD_TYPE_SHIFT;
/**
* Field type code for sfixed64 fields. Used to build constants in generated
* code for use with the {@link ProtoOutputStream#write(long, long)
* ProtoOutputStream.write(long, long)} method.
*/
public static final long FIELD_TYPE_SFIXED64 = 16L << FIELD_TYPE_SHIFT;
/**
* Field type code for sint32 fields. Used to build constants in generated
* code for use with the {@link ProtoOutputStream#write(long, int)
* ProtoOutputStream.write(long, int)} method.
*/
public static final long FIELD_TYPE_SINT32 = 17L << FIELD_TYPE_SHIFT;
/**
* Field type code for sint64 fields. Used to build constants in generated
* code for use with the {@link ProtoOutputStream#write(long, long)
* ProtoOutputStream.write(long, long)} method.
*/
public static final long FIELD_TYPE_SINT64 = 18L << FIELD_TYPE_SHIFT;
protected static final String[] FIELD_TYPE_NAMES = new String[]{
private static final @NonNull String[] FIELD_TYPE_NAMES = new String[]{
"Double",
"Float",
"Int64",
@@ -100,19 +291,94 @@ public abstract class ProtoStream {
//
// FieldId flags for whether the field is single, repeated or packed.
//
/**
* Bit offset for building a field id to be used with a
* <code>{@link ProtoOutputStream}.write(...)</code>.
*
* @see #FIELD_COUNT_MASK
* @see #FIELD_COUNT_UNKNOWN
* @see #FIELD_COUNT_SINGLE
* @see #FIELD_COUNT_REPEATED
* @see #FIELD_COUNT_PACKED
*/
public static final int FIELD_COUNT_SHIFT = 40;
/**
* Bit mask for selecting the field count when reading a field id that
* is used with a <code>{@link ProtoOutputStream}.write(...)</code> method.
*
* @see #FIELD_COUNT_SHIFT
* @see #FIELD_COUNT_MASK
* @see #FIELD_COUNT_UNKNOWN
* @see #FIELD_COUNT_SINGLE
* @see #FIELD_COUNT_REPEATED
* @see #FIELD_COUNT_PACKED
* @see <a href="https://developers.google.com/protocol-buffers/docs/encoding">Protobuf
* Encoding</a>
*/
public static final long FIELD_COUNT_MASK = 0x0fL << FIELD_COUNT_SHIFT;
/**
* Unknown field count, encoded into a field id used with a
* <code>{@link ProtoOutputStream}.write(...)</code> method.
*
* @see #FIELD_COUNT_SHIFT
* @see #FIELD_COUNT_MASK
* @see #FIELD_COUNT_SINGLE
* @see #FIELD_COUNT_REPEATED
* @see #FIELD_COUNT_PACKED
* @see <a href="https://developers.google.com/protocol-buffers/docs/encoding">Protobuf
* Encoding</a>
*/
public static final long FIELD_COUNT_UNKNOWN = 0;
/**
* Single field count, encoded into a field id used with a
* <code>{@link ProtoOutputStream}.write(...)</code> method.
*
* @see #FIELD_COUNT_SHIFT
* @see #FIELD_COUNT_MASK
* @see #FIELD_COUNT_UNKNOWN
* @see #FIELD_COUNT_REPEATED
* @see #FIELD_COUNT_PACKED
* @see <a href="https://developers.google.com/protocol-buffers/docs/encoding">Protobuf
* Encoding</a>
*/
public static final long FIELD_COUNT_SINGLE = 1L << FIELD_COUNT_SHIFT;
/**
* Repeated field count, encoded into a field id used with a
* <code>{@link ProtoOutputStream}.write(...)</code> method.
*
* @see #FIELD_COUNT_SHIFT
* @see #FIELD_COUNT_MASK
* @see #FIELD_COUNT_UNKNOWN
* @see #FIELD_COUNT_SINGLE
* @see #FIELD_COUNT_PACKED
* @see <a href="https://developers.google.com/protocol-buffers/docs/encoding">Protobuf
* Encoding</a>
*/
public static final long FIELD_COUNT_REPEATED = 2L << FIELD_COUNT_SHIFT;
/**
* Repeated packed field count, encoded into a field id used with a
* <code>{@link ProtoOutputStream}.write(...)</code> method.
*
* @see #FIELD_COUNT_SHIFT
* @see #FIELD_COUNT_MASK
* @see #FIELD_COUNT_UNKNOWN
* @see #FIELD_COUNT_SINGLE
* @see #FIELD_COUNT_REPEATED
* @see <a href="https://developers.google.com/protocol-buffers/docs/encoding">Protobuf
* Encoding</a>
*/
public static final long FIELD_COUNT_PACKED = 5L << FIELD_COUNT_SHIFT;
/**
* Get the developer-usable name of a field type.
*/
public static String getFieldTypeString(long fieldType) {
public static @Nullable String getFieldTypeString(long fieldType) {
int index = ((int) ((fieldType & FIELD_TYPE_MASK) >>> FIELD_TYPE_SHIFT)) - 1;
if (index >= 0 && index < FIELD_TYPE_NAMES.length) {
return FIELD_TYPE_NAMES[index];
@@ -124,7 +390,7 @@ public abstract class ProtoStream {
/**
* Get the developer-usable name of a field count.
*/
public static String getFieldCountString(long fieldCount) {
public static @Nullable String getFieldCountString(long fieldCount) {
if (fieldCount == FIELD_COUNT_SINGLE) {
return "";
} else if (fieldCount == FIELD_COUNT_REPEATED) {
@@ -139,7 +405,7 @@ public abstract class ProtoStream {
/**
* Get the developer-usable name of a wire type.
*/
public static String getWireTypeString(int wireType) {
public static @Nullable String getWireTypeString(int wireType) {
switch (wireType) {
case WIRE_TYPE_VARINT:
return "Varint";
@@ -161,7 +427,7 @@ public abstract class ProtoStream {
/**
* Get a debug string for a fieldId.
*/
public static String getFieldIdString(long fieldId) {
public static @NonNull String getFieldIdString(long fieldId) {
final long fieldCount = fieldId & FIELD_COUNT_MASK;
String countString = getFieldCountString(fieldCount);
if (countString == null) {
@@ -218,29 +484,39 @@ public abstract class ProtoStream {
/**
* Get the encoded tag size from the token.
*
* @hide
*/
public static int getTagSizeFromToken(long token) {
return (int) (0x7 & (token >> 61));
}
/**
* Get whether this is a call to startObject (false) or startRepeatedObject (true).
* Get whether the token has the repeated bit set to true or false
*
* @hide
*/
public static boolean getRepeatedFromToken(long token) {
return (0x1 & (token >> 60)) != 0;
}
/**
* Get the nesting depth of startObject calls from the token.
* Get the nesting depth from the token.
*
* @hide
*/
public static int getDepthFromToken(long token) {
return (int) (0x01ff & (token >> 51));
}
/**
* Get the object ID from the token. The object ID is a serial number for the
* Get the object ID from the token.
*
* <p>The object ID is a serial number for the
* startObject calls that have happened on this object. The values are truncated
* to 9 bits, but that is sufficient for error checking.
*
* @hide
*/
public static int getObjectIdFromToken(long token) {
return (int) (0x07ffff & (token >> 32));
@@ -248,6 +524,8 @@ public abstract class ProtoStream {
/**
* Get the location of the offset recorded in the token.
*
* @hide
*/
public static int getOffsetFromToken(long token) {
return (int) token;
@@ -255,8 +533,11 @@ public abstract class ProtoStream {
/**
* Convert the object ID to the ordinal value -- the n-th call to startObject.
* The object IDs start at -1 and count backwards, so that the value is unlikely
*
* <p>The object IDs start at -1 and count backwards, so that the value is unlikely
* to alias with an actual size field that had been written.
*
* @hide
*/
public static int convertObjectIdToOrdinal(int objectId) {
return (-1 & 0x07ffff) - objectId;
@@ -265,7 +546,7 @@ public abstract class ProtoStream {
/**
* Return a debugging string of a token.
*/
public static String token2String(long token) {
public static @NonNull String token2String(long token) {
if (token == 0L) {
return "Token(0)";
} else {
@@ -277,4 +558,9 @@ public abstract class ProtoStream {
+ ')';
}
}
/**
* @hide
*/
protected ProtoStream() {}
}

4
core/java/android/util/proto/ProtoUtils.java
View File

@@ -24,12 +24,12 @@ import java.io.IOException;
/**
* This class contains a list of helper functions to write common proto in
* //frameworks/base/core/proto/android/base directory
* @hide
*/
public class ProtoUtils {
/**
* Dump AggStats to ProtoOutputStream
* @hide
*/
public static void toAggStatsProto(ProtoOutputStream proto, long fieldId,
long min, long average, long max) {
@@ -42,7 +42,6 @@ public class ProtoUtils {
/**
* Dump Duration to ProtoOutputStream
* @hide
*/
public static void toDuration(ProtoOutputStream proto, long fieldId, long startMs, long endMs) {
final long token = proto.start(fieldId);
@@ -53,7 +52,6 @@ public class ProtoUtils {
/**
* Helper function to write bit-wise flags to proto as repeated enums
* @hide
*/
public static void writeBitWiseFlagsToProtoEnum(ProtoOutputStream proto, long fieldId,
int flags, int[] origEnums, int[] protoEnums) {

4
core/java/android/util/proto/package.html
View File

@@ -1,5 +1,5 @@
<html>
<body>
Provides utility classes to export protocol buffers from the system.
{@hide}
</body>
</html>