AvroRecordBuilder.java

/**
 * Copyright 2013 Cloudera Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.cloudera.cdk.data.hbase.avro;

/**
 * An builder interface used to construct Avro records. The Avro entity mapper
 * types must create Avro records, of which there are multiple classes. One
 * class of Avro record is GenericRecord. Another is SpecificRecord. These are
 * constructed in different ways.
 * 
 * For each class of avro record supported by the entity mappers, there should
 * be an AvroRecordBuilder implementation.
 * 
 * @param <T>
 *          The type of record to build.
 */
public interface AvroRecordBuilder<T> {

  /**
   * Add a value to a field of an avro record.
   * 
   * @param field
   *          The field to add a value for.
   * @param value
   *          The value to add.
   */
  public void put(String field, Object value);

  /**
   * Build the avro record.
   * 
   * @return The constructed avro record.
   */
  public T build();
}