io.grpc

Class Metadata.Key<T>

java.lang.Object

io.grpc.Metadata.Key<T>

Enclosing class:

Metadata

public abstract static class Metadata.Key<T>
extends Object

Key for metadata entries. Allows for parsing and serialization of metadata.

Valid characters in key names

Only the following ASCII characters are allowed in the names of keys:

• letters, i.e., a-z and A-Z
• digits, i.e., 0-9
• dash, i.e., -
• underscore, i.e., _

Note this has to be the subset of valid HTTP/2 token characters as defined in RFC7230 Section 3.2.6

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
int	hashCode()
String	name()
static <T> Metadata.Key<T>	of(String name, Metadata.AsciiMarshaller<T> marshaller) Creates a key for an ASCII header.
static <T> Metadata.Key<T>	of(String name, Metadata.BinaryMarshaller<T> marshaller) Creates a key for a binary header.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

of

public static <T> Metadata.Key<T> of(String name,
                                     Metadata.BinaryMarshaller<T> marshaller)

Creates a key for a binary header.

Parameters:

name - Must contain only the valid key characters as defined in the class comment. Must end with Metadata.BINARY_HEADER_SUFFIX.

of

public static <T> Metadata.Key<T> of(String name,
                                     Metadata.AsciiMarshaller<T> marshaller)

Creates a key for an ASCII header.

Parameters:

name - Must contain only the valid key characters as defined in the class comment. Must not end with Metadata.BINARY_HEADER_SUFFIX

name

public String name()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object