Modifier and Type	Class and Description
public class	Protocol.Message A protocol message.
private class	Protocol.TwoWayMessage

Access	Constructor and Description
private	Protocol()
public	Protocol(Protocol p) Constructs a similar Protocol instance with the same `name`, `doc`, and `namespace` as {code p} has.
public	Protocol(String name, String doc, String namespace)
public	Protocol(String name, String namespace)

Method Summary

Modifier and Type	Method and Description
public Protocol.Message	createMessage(String name, String doc, Schema request) Deprecated Create a one-way message.
public Protocol.Message	createMessage(Protocol.Message m, Schema request) Create a one-way message using the `name`, `doc`, and `props` of `m`.
public <T> Protocol.Message	createMessage(String name, String doc, JsonProperties propMap, Schema request) Create a one-way message.
public <T> Protocol.Message	createMessage(String name, String doc, Map<String, ?> propMap, Schema request) Create a one-way message.
public Protocol.Message	createMessage(String name, String doc, Schema request, Schema response, Schema errors) Deprecated Create a two-way message.
public Protocol.Message	createMessage(Protocol.Message m, Schema request, Schema response, Schema errors) Create a two-way message using the `name`, `doc`, and `props` of `m`.
public <T> Protocol.Message	createMessage(String name, String doc, JsonProperties propMap, Schema request, Schema response, Schema errors) Create a two-way message.
public <T> Protocol.Message	createMessage(String name, String doc, Map<String, ?> propMap, Schema request, Schema response, Schema errors) Create a two-way message.
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public String	getDoc() Doc string for this protocol.
public byte[]	getMD5() Return the MD5 hash of the text of this protocol.
public Map<String, Protocol.Message>	getMessages() The messages of this protocol.
public String	getName() The name of this protocol.
public String	getNamespace() The namespace of this protocol.
public Schema	getType(String name) Returns the named type.
public Collection<Schema>	getTypes() The types of this protocol.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public static void	main(String[] args)
public static Protocol	parse(File file) Read a protocol from a Json file.
public static Protocol	parse(InputStream stream) Read a protocol from a Json stream.
public static Protocol	parse(String string, String... more) Read a protocol from one or more json strings
public static Protocol	parse(String string) Read a protocol from a Json string.
private static Protocol	parse(JsonParser parser)
private void	parse(JsonNode json)
private void	parseDoc(JsonNode json)
private String	parseDocNode(JsonNode json)
private Protocol.Message	parseMessage(String messageName, JsonNode json)
private void	parseMessages(JsonNode json)
private void	parseNameAndNamespace(JsonNode json)
private void	parseProps(JsonNode json)
private void	parseTypes(JsonNode json)
private void	setName(String name, String namespace)
public void	setTypes(Collection<Schema> newTypes) Set the types of this protocol.
pack-priv void	toJson(JsonGenerator gen)
public String	toString() Overrides java.lang.Object.toString. Render this as JSON.
public String	toString(boolean if true, pretty-print JSON. pretty) Render this as JSON.

Inherited from org.apache.avro.JsonProperties:: addAllProps addProp addProp getObjectProp getObjectProps getProp hasProps propsEqual propsHashCode putAll writeProps

Field Detail

doc	back to summary
private String doc

FIELD_RESERVED	back to summary
private static final Set<String> FIELD_RESERVED

md5	back to summary
private byte[] md5

MESSAGE_RESERVED	back to summary
private static final Set<String> MESSAGE_RESERVED

messages	back to summary
private final Map<String, Protocol.Message> messages

name	back to summary
private String name

namespace	back to summary
private String namespace

PROTOCOL_RESERVED	back to summary
private static final Set<String> PROTOCOL_RESERVED

SYSTEM_ERROR	back to summary
public static final Schema SYSTEM_ERROR An error that can be thrown by any message.

SYSTEM_ERRORS	back to summary
public static final Schema SYSTEM_ERRORS Union type for generating system errors.

types	back to summary
private Schema.Names types

VERSION	back to summary
public static final long VERSION The version of the protocol specification implemented here.

Constructor Detail

Protocol	back to summary
private Protocol()

Protocol	back to summary
public Protocol(Protocol p) Constructs a similar Protocol instance with the same `name`, `doc`, and `namespace` as {code p} has. It also copies all the `props`.

Protocol	back to summary
public Protocol(String name, String doc, String namespace)

Protocol	back to summary
public Protocol(String name, String namespace)

Method Detail

createMessage	back to summary
public Protocol.Message createMessage(String name, String doc, Schema request) Deprecated Create a one-way message. Annotations @Deprecated

createMessage

back to summary

public Protocol.Message createMessage(String name, String doc, Schema request)

Deprecated

Create a one-way message.

Annotations

@Deprecated

createMessage	back to summary
public Protocol.Message createMessage(Protocol.Message m, Schema request) Create a one-way message using the `name`, `doc`, and `props` of `m`.

createMessage	back to summary
public <T> Protocol.Message createMessage(String name, String doc, JsonProperties propMap, Schema request) Create a one-way message.

createMessage	back to summary
public <T> Protocol.Message createMessage(String name, String doc, Map<String, ?> propMap, Schema request) Create a one-way message.

createMessage	back to summary
public Protocol.Message createMessage(String name, String doc, Schema request, Schema response, Schema errors) Deprecated Create a two-way message. Annotations @Deprecated

createMessage

back to summary

public Protocol.Message createMessage(String name, String doc, Schema request, Schema response, Schema errors)

Deprecated

Create a two-way message.

Annotations

@Deprecated

createMessage	back to summary
public Protocol.Message createMessage(Protocol.Message m, Schema request, Schema response, Schema errors) Create a two-way message using the `name`, `doc`, and `props` of `m`.

createMessage	back to summary
public <T> Protocol.Message createMessage(String name, String doc, JsonProperties propMap, Schema request, Schema response, Schema errors) Create a two-way message.

createMessage	back to summary
public <T> Protocol.Message createMessage(String name, String doc, Map<String, ?> propMap, Schema request, Schema response, Schema errors) Create a two-way message.

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getDoc	back to summary
public String getDoc() Doc string for this protocol.

getMD5	back to summary
public byte[] getMD5() Return the MD5 hash of the text of this protocol.

getMessages	back to summary
public Map<String, Protocol.Message> getMessages() The messages of this protocol.

getName	back to summary
public String getName() The name of this protocol.

getNamespace	back to summary
public String getNamespace() The namespace of this protocol. Qualifies its name.

getType	back to summary
public Schema getType(String name) Returns the named type.

getTypes	back to summary
public Collection<Schema> getTypes() The types of this protocol.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

main	back to summary
public static void main(String[] args) throws Exception

parse	back to summary
public static Protocol parse(File file) throws IOException Read a protocol from a Json file.

parse	back to summary
public static Protocol parse(InputStream stream) throws IOException Read a protocol from a Json stream.

parse	back to summary
public static Protocol parse(String string, String... more) Read a protocol from one or more json strings

parse	back to summary
public static Protocol parse(String string) Read a protocol from a Json string.

parse	back to summary
private static Protocol parse(JsonParser parser)

parse	back to summary
private void parse(JsonNode json)

parseDoc	back to summary
private void parseDoc(JsonNode json)

parseDocNode	back to summary
private String parseDocNode(JsonNode json)

parseMessage	back to summary
private Protocol.Message parseMessage(String messageName, JsonNode json)

parseMessages	back to summary
private void parseMessages(JsonNode json)

parseNameAndNamespace	back to summary
private void parseNameAndNamespace(JsonNode json)

parseProps	back to summary
private void parseProps(JsonNode json)

parseTypes	back to summary
private void parseTypes(JsonNode json)

setName	back to summary
private void setName(String name, String namespace)

setTypes	back to summary
public void setTypes(Collection<Schema> newTypes) Set the types of this protocol.

toJson	back to summary
pack-priv void toJson(JsonGenerator gen) throws IOException

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Render this as JSON.

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object.

Annotations

@Override

toString

back to summary

public String toString(boolean pretty)

Render this as JSON.

Parameters

pretty:boolean: if true, pretty-print JSON.

org.apache.avro back to summary

public Class Protocol.Message

Class Inheritance

extends JsonProperties

java.lang.Object
org.apache.avro.JsonProperties
org.apache.avro.Protocol.Message

Known Direct Subclasses

org.apache.avro.Protocol.TwoWayMessage

A protocol message.

Field Summary

Modifier and Type	Field and Description
private String	doc
private String	name
private Schema	request

Inherited from org.apache.avro.JsonProperties:: NULL_VALUE

Constructor Summary

Access	Constructor and Description
private	Message(String name, String doc, JsonProperties propMap, Schema request) Construct a message.
private	Message(String name, String doc, Map<String, ?> propMap, Schema request)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public String	getDoc()
public Schema	getErrors() Errors that might be thrown.
public String	getName() The name of this message.
public Schema	getRequest() The parameters of this message.
public Schema	getResponse() The returned data.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public boolean	isOneWay() Returns true if this is a one-way message, with no response or errors.
pack-priv void	toJson(JsonGenerator gen)
pack-priv void	toJson1(JsonGenerator gen)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from org.apache.avro.JsonProperties:: addAllProps addProp addProp getObjectProp getObjectProps getProp hasProps propsEqual propsHashCode putAll writeProps

Field Detail

doc	back to summary
private String doc

name	back to summary
private String name

request	back to summary
private Schema request

Constructor Detail

Message	back to summary
private Message(String name, String doc, JsonProperties propMap, Schema request) Construct a message.

Message	back to summary
private Message(String name, String doc, Map<String, ?> propMap, Schema request)

Method Detail

equals back to summary

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getDoc	back to summary
public String getDoc()

getErrors	back to summary
public Schema getErrors() Errors that might be thrown.

getName	back to summary
public String getName() The name of this message.

getRequest	back to summary
public Schema getRequest() The parameters of this message.

getResponse	back to summary
public Schema getResponse() The returned data.

hashCode back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

isOneWay	back to summary
public boolean isOneWay() Returns true if this is a one-way message, with no response or errors.

toJson	back to summary
pack-priv void toJson(JsonGenerator gen) throws IOException

toJson1	back to summary
pack-priv void toJson1(JsonGenerator gen) throws IOException

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

org.apache.avro back to summary

private Class Protocol.TwoWayMessage

Class Inheritance

extends Message

Field Summary

Modifier and Type	Field and Description
private Schema	errors
private Schema	response

Constructor Summary

Access	Constructor and Description
private	TwoWayMessage(String name, String doc, Map<String, ?> propMap, Schema request, Schema response, Schema errors) Construct a message.
private	TwoWayMessage(String name, String doc, JsonProperties propMap, Schema request, Schema response, Schema errors)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. o) Overrides org.apache.avro.Protocol.Message.equals. Indicates whether some other object is "equal to" this one.
public Schema	getErrors() Overrides org.apache.avro.Protocol.Message.getErrors. Errors that might be thrown.
public Schema	getResponse() Overrides org.apache.avro.Protocol.Message.getResponse. The returned data.
public int	hashCode() Overrides org.apache.avro.Protocol.Message.hashCode. Returns a hash code value for the object.
public boolean	isOneWay() Overrides org.apache.avro.Protocol.Message.isOneWay. Returns true if this is a one-way message, with no response or errors.
pack-priv void	toJson1(JsonGenerator gen) Overrides org.apache.avro.Protocol.Message.toJson1.

Inherited from org.apache.avro.Protocol.Message:: getDoc getName getRequest toJson toString

Field Detail

errors	back to summary
private Schema errors

response	back to summary
private Schema response

Constructor Detail

TwoWayMessage	back to summary
private TwoWayMessage(String name, String doc, Map<String, ?> propMap, Schema request, Schema response, Schema errors) Construct a message.

TwoWayMessage	back to summary
private TwoWayMessage(String name, String doc, JsonProperties propMap, Schema request, Schema response, Schema errors)

Method Detail

equals back to summary

public boolean equals(Object o)

Overrides org.apache.avro.Protocol.Message.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getErrors

back to summary

public Schema getErrors()

Overrides org.apache.avro.Protocol.Message.getErrors.

Doc from org.apache.avro.Protocol.Message.getErrors.

Errors that might be thrown.

Annotations

@Override

getResponse

back to summary

public Schema getResponse()

Overrides org.apache.avro.Protocol.Message.getResponse.

Doc from org.apache.avro.Protocol.Message.getResponse.

The returned data.

Annotations

@Override

hashCode back to summary

public int hashCode()

Overrides org.apache.avro.Protocol.Message.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

isOneWay

back to summary

public boolean isOneWay()

Overrides org.apache.avro.Protocol.Message.isOneWay.

Doc from org.apache.avro.Protocol.Message.isOneWay.

Returns true if this is a one-way message, with no response or errors.

Annotations

@Override

toJson1

back to summary

pack-priv void toJson1(JsonGenerator gen) throws IOException

Overrides org.apache.avro.Protocol.Message.toJson1.

Annotations

@Override

Modifier and Type	Field and Description
private String	doc
private static final Set<String>	FIELD_RESERVED
private byte[]	md5
private static final Set<String>	MESSAGE_RESERVED
private final Map<String, Protocol.Message>	messages
private String	name
private String	namespace
private static final Set<String>	PROTOCOL_RESERVED
public static final Schema	SYSTEM_ERROR An error that can be thrown by any message.
public static final Schema	SYSTEM_ERRORS Union type for generating system errors.
private Schema.Names	types
public static final long	VERSION The version of the protocol specification implemented here.

public Class Protocol

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Protocol.Message

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class Protocol.TwoWayMessage

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail