grpc
/
grpc-java
mirror of https://github.com/grpc/grpc-java.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Make docs more strict for byte[] methods in Metadata

This commit is contained in:
Eric Anderson 2015-07-19 09:50:19 -07:00
parent 5698ccaee6
commit 50e28c2ca0
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
core/src/main/java/io/grpc/Metadata.java
View File

@ -199,6 +199,10 @@ public abstract class Metadata {
* *
* <p>Names are ASCII string bytes. If the name ends with "-bin", the value can be raw binary. * <p>Names are ASCII string bytes. If the name ends with "-bin", the value can be raw binary.
* Otherwise, the value must be printable ASCII characters or space. * Otherwise, the value must be printable ASCII characters or space.
*
* <p>The returned byte arrays <em>must not</em> be modified.
*
* <p>This method is intended for transport use only.
*/ */
public byte[][] serialize() { public byte[][] serialize() {
Preconditions.checkState(serializable, "Can't serialize raw metadata"); Preconditions.checkState(serializable, "Can't serialize raw metadata");
@ -261,6 +265,8 @@ public abstract class Metadata {
/** /**
* Called by the transport layer to create headers from their binary serialized values. * Called by the transport layer to create headers from their binary serialized values.
*
* <p>This method does not copy the provided byte arrays. The byte arrays must not be mutated.
*/ */
public Headers(byte[]... headers) { public Headers(byte[]... headers) {
super(headers); super(headers);
@ -339,6 +345,8 @@ public abstract class Metadata {
public static class Trailers extends Metadata { public static class Trailers extends Metadata {
/** /**
* Called by the transport layer to create trailers from their binary serialized values. * Called by the transport layer to create trailers from their binary serialized values.
*
* <p>This method does not copy the provided byte arrays. The byte arrays must not be mutated.
*/ */
public Trailers(byte[]... headers) { public Trailers(byte[]... headers) {
super(headers); super(headers);
@ -434,6 +442,13 @@ public abstract class Metadata {
return name; return name;
} }
/**
* Get the name as bytes using ASCII-encoding.
*
* <p>The returned byte arrays <em>must not</em> be modified.
*
* <p>This method is intended for transport use only.
*/
// TODO (louiscryan): Migrate to ByteString // TODO (louiscryan): Migrate to ByteString
public byte[] asciiName() { public byte[] asciiName() {
return asciiName; return asciiName;