public abstract Class Encoder

Call this method before writing a batch of items in an array or a map. Then for each item, call startItem() followed by any of the other write methods of Encoder. The number of calls to startItem() must be equal to the count specified in setItemCount. Once a batch is completed you can start another batch with setItemCount.

Parameters

itemCount:long

The number of startItem() calls to follow.

Start a new item of an array or map. See writeArrayStart for usage information.

Exceptions

AvroTypeException:

If called outside of an array or map context

Call this method to finish writing an array. See writeArrayStart for usage information.

Exceptions

AvroTypeException:

• If items written does not match count provided to writeArrayStart
• If not currently inside an array

Call this method to start writing an array. When starting to serialize an array, call writeArrayStart. Then, before writing any data for any item call setItemCount followed by a sequence of startItem() and the item itself. The number of startItem() should match the number specified in setItemCount. When actually writing the data of the item, you can call any Encoder method (e.g., writeLong). When all items of the array have been written, call writeArrayEnd. As an example, let's say you want to write an array of records, the record consisting of an Long field and a Boolean field. Your code would look something like this:

out.writeArrayStart();
out.setItemCount(list.size());
for (Record r : list) {
  out.startItem();
  out.writeLong(r.longField);
  out.writeBoolean(r.boolField);
}
out.writeArrayEnd();

Exceptions

AvroTypeException:

If this is a stateful writer and an array is not expected

Write a boolean value.

Exceptions

AvroTypeException:

If this is a stateful writer and a boolean is not expected

Write a byte string.

Exceptions

AvroTypeException:

If this is a stateful writer and a byte-string is not expected

Write a byte string.

Exceptions

AvroTypeException:

If this is a stateful writer and a byte-string is not expected

Writes a byte string. Equivalent to writeBytes(bytes, 0, bytes.length)

Exceptions

AvroTypeException:

If this is a stateful writer and a byte-string is not expected

Write a double.

Exceptions

AvroTypeException:

If this is a stateful writer and a double is not expected

Writes an enumeration.

Exceptions

AvroTypeException:

If this is a stateful writer and an enumeration is not expected or the e is out of range.

Writes a fixed size binary object.

Parameters

bytes:byte[]

The contents to write

start:int

The position within bytes where the contents start.

len:int

The number of bytes to write.

Exceptions

AvroTypeException:

If this is a stateful writer and a byte-string is not expected

A shorthand for writeFixed(bytes, 0, bytes.length)

Writes a fixed from a ByteBuffer.

Write a float.

Exceptions

AvroTypeException:

If this is a stateful writer and a float is not expected

Call this method to write the tag of a union. As an example of usage, let's say you want to write a union, whose second branch is a record consisting of an Long field and a Boolean field. Your code would look something like this:

out.writeIndex(1);
out.writeLong(record.longField);
out.writeBoolean(record.boolField);

Exceptions

AvroTypeException:

If this is a stateful writer and a map is not expected

Writes a 32-bit integer.

Exceptions

AvroTypeException:

If this is a stateful writer and an integer is not expected

Write a 64-bit integer.

Exceptions

AvroTypeException:

If this is a stateful writer and a long is not expected

Call this method to terminate the inner-most, currently-opened map. See writeArrayStart for more details.

Exceptions

AvroTypeException:

• If items written does not match count provided to writeMapStart
• If not currently inside a map

Call this to start a new map. See writeArrayStart for details on usage. As an example of usage, let's say you want to write a map of records, the record consisting of an Long field and a Boolean field. Your code would look something like this:

out.writeMapStart();
out.setItemCount(list.size());
for (Map.Entry entry : map.entrySet()) {
  out.startItem();
  out.writeString(entry.getKey());
  out.writeLong(entry.getValue().longField);
  out.writeBoolean(entry.getValue().boolField);
}
out.writeMapEnd();

Exceptions

AvroTypeException:

If this is a stateful writer and a map is not expected

"Writes" a null value. (Doesn't actually write anything, but advances the state of the parser if this class is stateful.)

Exceptions

AvroTypeException:

If this is a stateful writer and a null is not expected

Write a Unicode character string.

Exceptions

AvroTypeException:

If this is a stateful writer and a char-string is not expected

Write a Unicode character string. The default implementation converts the String to a org.apache.avro.util.Utf8. Some Encoder implementations may want to do something different as a performance optimization.

Exceptions

AvroTypeException:

If this is a stateful writer and a char-string is not expected

Write a Unicode character string. If the CharSequence is an org.apache.avro.util.Utf8 it writes this directly, otherwise the CharSequence is converted to a String via toString() and written.

Exceptions

AvroTypeException:

If this is a stateful writer and a char-string is not expected