Merge "Address API Council comments for ProtoOutputStream" into rvc-dev (e5f64000) · Commits · e / os / android_frameworks_base

core/java/android/util/proto/ProtoOutputStream.java

+8 −3

Original line number	Diff line number	Diff line
		@@ -201,7 +201,9 @@ public final class ProtoOutputStream extends ProtoStream {
		}

		/**
		* Returns the uncompressed buffer size
		* Returns the total size of the data that has been written, after full
		* protobuf encoding has occurred.
		*
		* @return the uncompressed buffer size
		*/
		public int getRawSize() {
		@@ -2271,9 +2273,12 @@ public final class ProtoOutputStream extends ProtoStream {
		}

		/**
		* Write a field tag to the stream.
		* Write an individual field tag by hand.
		*
		* @see See <a href="https://developers.google.com/protocol-buffers/docs/encoding">Protobuf
		* Encoding</a> for details on the structure of how tags and data are written.
		*/
		public void writeTag(int id, int wireType) {
		public void writeTag(int id, @WireType int wireType) {
		mBuffer.writeRawVarint32((id << FIELD_ID_SHIFT) \| wireType);
		}

core/java/android/util/proto/ProtoStream.java

+73 −3

Original line number	Diff line number	Diff line
		@@ -16,9 +16,14 @@

		package android.util.proto;

		import android.annotation.IntDef;
		import android.annotation.LongDef;
		import android.annotation.NonNull;
		import android.annotation.Nullable;

		import java.lang.annotation.Retention;
		import java.lang.annotation.RetentionPolicy;

		/**
		* Base utility class for protobuf streams.
		*
		@@ -29,6 +34,71 @@ import android.annotation.Nullable;
		*/
		public class ProtoStream {

		/**
		* A protobuf wire type. All application-level types are represented using
		* varint, fixed64, length-delimited and fixed32 wire types. The start-group
		* and end-group types are unused in modern protobuf versions (proto2 and proto3),
		* but are included here for completeness.
		*
		* @see <a href="https://developers.google.com/protocol-buffers/docs/encoding">Protobuf
		* Encoding</a>
		*/
		@Retention(RetentionPolicy.SOURCE)
		@IntDef({
		WIRE_TYPE_VARINT,
		WIRE_TYPE_FIXED64,
		WIRE_TYPE_LENGTH_DELIMITED,
		WIRE_TYPE_START_GROUP,
		WIRE_TYPE_END_GROUP,
		WIRE_TYPE_FIXED32
		})
		public @interface WireType {}

		/**
		* Application-level protobuf field types, as would be used in a .proto file.
		*
		* @see <a href="https://developers.google.com/protocol-buffers/docs/encoding">Protobuf
		* Encoding</a>
		*/
		@Retention(RetentionPolicy.SOURCE)
		@LongDef({
		FIELD_TYPE_UNKNOWN,
		FIELD_TYPE_DOUBLE,
		FIELD_TYPE_FLOAT,
		FIELD_TYPE_INT64,
		FIELD_TYPE_UINT64,
		FIELD_TYPE_INT32,
		FIELD_TYPE_FIXED64,
		FIELD_TYPE_FIXED32,
		FIELD_TYPE_BOOL,
		FIELD_TYPE_STRING,
		FIELD_TYPE_MESSAGE,
		FIELD_TYPE_BYTES,
		FIELD_TYPE_UINT32,
		FIELD_TYPE_ENUM,
		FIELD_TYPE_SFIXED32,
		FIELD_TYPE_SFIXED64,
		FIELD_TYPE_SINT32,
		FIELD_TYPE_SINT64,
		})
		public @interface FieldType {}


		/**
		* Represents the cardinality of a protobuf field.
		*
		* @see <a href="https://developers.google.com/protocol-buffers/docs/encoding">Protobuf
		* Encoding</a>
		*/
		@Retention(RetentionPolicy.SOURCE)
		@LongDef({
		FIELD_COUNT_UNKNOWN,
		FIELD_COUNT_SINGLE,
		FIELD_COUNT_REPEATED,
		FIELD_COUNT_PACKED,
		})
		public @interface FieldCount {}

		/**
		* Number of bits to shift the field number to form a tag.
		*
		@@ -128,7 +198,7 @@ public class ProtoStream {
		public static final long FIELD_TYPE_MASK = 0x0ffL << FIELD_TYPE_SHIFT;

		/**
		* Not a real wire type.
		* Not a real field type.
		* @hide
		*/
		public static final long FIELD_TYPE_UNKNOWN = 0;
		@@ -378,7 +448,7 @@ public class ProtoStream {
		/**
		* Get the developer-usable name of a field type.
		*/
		public static @Nullable String getFieldTypeString(long fieldType) {
		public static @Nullable String getFieldTypeString(@FieldType 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];
		@@ -405,7 +475,7 @@ public class ProtoStream {
		/**
		* Get the developer-usable name of a wire type.
		*/
		public static @Nullable String getWireTypeString(int wireType) {
		public static @Nullable String getWireTypeString(@WireType int wireType) {
		switch (wireType) {
		case WIRE_TYPE_VARINT:
		return "Varint";