HADOOP-6155. Deprecate RecordIO anticipating Avro. Contributed by Tom White

git-svn-id: https://svn.apache.org/repos/asf/hadoop/common/trunk@898740 13f79535-47bb-0310-9956-ffa450edef68

CHANGES.txt

@@ -99,6 +99,8 @@ Trunk (unreleased changes)
     HADOOP-6420. Add functionality permitting subsets of Configuration to be
     interpreted as Map<String,String>. (Aaron Kimball via cdouglas)
 
+    HADOOP-6155. Deprecate RecordIO anticipating Avro. (Tom White via cdouglas)
+
   OPTIMIZATIONS
 
   BUG FIXES

src/java/org/apache/hadoop/record/BinaryRecordInput.java

@@ -24,7 +24,9 @@ import java.io.DataInputStream;
 import java.io.InputStream;
 
 /**
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
  */
+@Deprecated
 public class BinaryRecordInput implements RecordInput {
     
   private DataInput in;

src/java/org/apache/hadoop/record/BinaryRecordOutput.java

@@ -26,7 +26,9 @@ import java.io.DataOutputStream;
 import java.io.OutputStream;
 
 /**
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
  */
+@Deprecated
 public class BinaryRecordOutput implements RecordOutput {
     
   private DataOutput out;

src/java/org/apache/hadoop/record/Buffer.java

@@ -25,7 +25,9 @@ import java.io.UnsupportedEncodingException;
  * It is resizable and distinguishes between the count of the seqeunce and
  * the current capacity.
  * 
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
  */
+@Deprecated
 public class Buffer implements Comparable, Cloneable {
   /** Number of valid bytes in this.bytes. */
   private int count;

src/java/org/apache/hadoop/record/CsvRecordInput.java

@@ -25,7 +25,9 @@ import java.io.PushbackReader;
 import java.io.UnsupportedEncodingException;
 
 /**
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
  */
+@Deprecated
 public class CsvRecordInput implements RecordInput {
     
   private PushbackReader stream;

src/java/org/apache/hadoop/record/CsvRecordOutput.java

@@ -26,7 +26,9 @@ import java.io.OutputStream;
 import java.io.UnsupportedEncodingException;
 
 /**
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
  */
+@Deprecated
 public class CsvRecordOutput implements RecordOutput {
 
   private PrintStream stream;

src/java/org/apache/hadoop/record/Index.java

@@ -30,7 +30,10 @@ package org.apache.hadoop.record;
  *   idx.incr();
  * }
  * </code>
+ * 
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
  */
+@Deprecated
 public interface Index {
   boolean done();
   void incr();

src/java/org/apache/hadoop/record/Record.java

@@ -27,7 +27,9 @@ import org.apache.hadoop.io.WritableComparable;
 /**
  * Abstract class that is extended by generated classes.
  * 
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
  */
+@Deprecated
 public abstract class Record implements WritableComparable, Cloneable {
   
   /**

src/java/org/apache/hadoop/record/RecordComparator.java

@@ -23,7 +23,10 @@ import org.apache.hadoop.io.WritableComparator;
 
 /**
  * A raw record comparator base class
+ * 
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
  */
+@Deprecated
 public abstract class RecordComparator extends WritableComparator {
   
   /**

src/java/org/apache/hadoop/record/RecordInput.java

@@ -22,7 +22,10 @@ import java.io.IOException;
 
 /**
  * Interface that all the Deserializers have to implement.
+ * 
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
  */
+@Deprecated
 public interface RecordInput {
   /**
    * Read a byte from serialized record.

src/java/org/apache/hadoop/record/RecordOutput.java

@@ -24,7 +24,10 @@ import java.util.ArrayList;
 
 /**
  * Interface that alll the serializers have to implement.
+ * 
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
  */
+@Deprecated
 public interface RecordOutput {
   /**
    * Write a byte to serialized record.

src/java/org/apache/hadoop/record/Utils.java

@@ -26,7 +26,10 @@ import org.apache.hadoop.io.WritableUtils;
 
 /**
  * Various utility functions for Hadooop record I/O runtime.
+ * 
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
  */
+@Deprecated
 public class Utils {
   
   /** Cannot create a new instance of Utils */

src/java/org/apache/hadoop/record/XmlRecordInput.java

@@ -29,7 +29,10 @@ import javax.xml.parsers.SAXParser;
 
 /**
  * XML Deserializer.
+ * 
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
  */
+@Deprecated
 public class XmlRecordInput implements RecordInput {
     
   static private class Value {

src/java/org/apache/hadoop/record/XmlRecordOutput.java

@@ -28,7 +28,10 @@ import java.util.Stack;
 
 /**
  * XML Serializer.
+ * 
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
  */
+@Deprecated
 public class XmlRecordOutput implements RecordOutput {
 
   private PrintStream stream;

src/java/org/apache/hadoop/record/compiler/CodeBuffer.java

@@ -21,7 +21,10 @@ import java.util.ArrayList;
 
 /**
  * A wrapper around StringBuffer that automatically does indentation
+ * 
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
  */
+@Deprecated
 public class CodeBuffer {
   
   static private ArrayList<Character> startMarkers = new ArrayList<Character>();

src/java/org/apache/hadoop/record/compiler/Consts.java

@@ -24,7 +24,10 @@ import org.apache.hadoop.record.RecordInput;
 
 /**
  * const definitions for Record I/O compiler
+ * 
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
  */
+@Deprecated
 public class Consts {
   
   /** Cannot create a new instance */

src/java/org/apache/hadoop/record/compiler/JBoolean.java

@@ -20,7 +20,9 @@ package org.apache.hadoop.record.compiler;
 
 
 /**
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
  */
+@Deprecated
 public class JBoolean extends JType {
   
   class JavaBoolean extends JType.JavaType {

src/java/org/apache/hadoop/record/compiler/JBuffer.java

@@ -21,7 +21,10 @@ package org.apache.hadoop.record.compiler;
 
 /**
  * Code generator for "buffer" type.
+ * 
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
  */
+@Deprecated
 public class JBuffer extends JCompType {
   
   class JavaBuffer extends JavaCompType {

src/java/org/apache/hadoop/record/compiler/JByte.java

@@ -20,7 +20,10 @@ package org.apache.hadoop.record.compiler;
 
 /**
  * Code generator for "byte" type.
+ * 
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
  */
+@Deprecated
 public class JByte extends JType {
   
   class JavaByte extends JavaType {

src/java/org/apache/hadoop/record/compiler/JCompType.java

@@ -22,7 +22,10 @@ package org.apache.hadoop.record.compiler;
 /**
  * Abstract base class for all the "compound" types such as ustring,
  * buffer, vector, map, and record.
+ * 
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
  */
+@Deprecated
 abstract class JCompType extends JType {
   
   abstract class JavaCompType extends JavaType {

src/java/org/apache/hadoop/record/compiler/JDouble.java

@@ -20,7 +20,9 @@ package org.apache.hadoop.record.compiler;
 
 
 /**
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
  */
+@Deprecated
 public class JDouble extends JType {
   
   class JavaDouble extends JavaType {

src/java/org/apache/hadoop/record/compiler/JField.java

@@ -20,7 +20,10 @@ package org.apache.hadoop.record.compiler;
 
 /**
  * A thin wrappper around record field.
+ * 
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
  */
+@Deprecated
 public class JField<T> {
   
   private String name;

src/java/org/apache/hadoop/record/compiler/JFile.java

@@ -25,7 +25,10 @@ import java.util.ArrayList;
  * Container for the Hadoop Record DDL.
  * The main components of the file are filename, list of included files,
  * and records defined in that file.
+ * 
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
  */
+@Deprecated
 public class JFile {
   /** Possibly full name of the file */
   private String mName;

src/java/org/apache/hadoop/record/compiler/JFloat.java

@@ -19,7 +19,9 @@
 package org.apache.hadoop.record.compiler;
 
 /**
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
  */
+@Deprecated
 public class JFloat extends JType {
   
   class JavaFloat extends JavaType {

src/java/org/apache/hadoop/record/compiler/JInt.java

@@ -21,7 +21,10 @@ package org.apache.hadoop.record.compiler;
 
 /**
  * Code generator for "int" type
+ * 
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
  */
+@Deprecated
 public class JInt extends JType {
   
   class JavaInt extends JavaType {

src/java/org/apache/hadoop/record/compiler/JLong.java

@@ -20,7 +20,10 @@ package org.apache.hadoop.record.compiler;
 
 /**
  * Code generator for "long" type
+ * 
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
  */
+@Deprecated
 public class JLong extends JType {
   
   class JavaLong extends JavaType {

src/java/org/apache/hadoop/record/compiler/JMap.java

@@ -22,7 +22,9 @@ import java.util.Map;
 
 
 /**
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
  */
+@Deprecated
 public class JMap extends JCompType {
   
   static private int level = 0;

src/java/org/apache/hadoop/record/compiler/JRecord.java

@@ -24,7 +24,9 @@ import java.io.IOException;
 import java.util.*;
 
 /**
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
  */
+@Deprecated
 public class JRecord extends JCompType {
   
   class JavaRecord extends JavaCompType {

src/java/org/apache/hadoop/record/compiler/JString.java

@@ -20,7 +20,9 @@ package org.apache.hadoop.record.compiler;
 
 
 /**
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
  */
+@Deprecated
 public class JString extends JCompType {
     
   class JavaString extends JavaCompType {

src/java/org/apache/hadoop/record/compiler/JType.java

@@ -23,7 +23,10 @@ import java.util.Map;
 
 /**
  * Abstract Base class for all types supported by Hadoop Record I/O.
+ * 
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
  */
+@Deprecated
 abstract public class JType {
   
   static String toCamelCase(String name) {

src/java/org/apache/hadoop/record/compiler/JVector.java

@@ -21,7 +21,9 @@ package org.apache.hadoop.record.compiler;
 import java.util.Map;
 
 /**
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
  */
+@Deprecated
 public class JVector extends JCompType {
   
   static private int level = 0;

src/java/org/apache/hadoop/record/compiler/ant/RccTask.java

@@ -46,7 +46,10 @@ import org.apache.tools.ant.types.FileSet;
  *   <fileset include="**\/*.jr" />
  * </recordcc>
  * </pre>
+ * 
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
  */
+@Deprecated
 public class RccTask extends Task {
   
   private String language = "java";

src/java/org/apache/hadoop/record/compiler/generated/ParseException.java

@@ -27,7 +27,10 @@ package org.apache.hadoop.record.compiler.generated;
  *
  * You can modify this class to customize your error reporting
  * mechanisms so long as you retain the public fields.
+ * 
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
  */
+@Deprecated
 public class ParseException extends Exception {
 
   /**

src/java/org/apache/hadoop/record/compiler/generated/Rcc.java

@@ -28,6 +28,10 @@ import java.io.FileReader;
 import java.io.FileNotFoundException;
 import java.io.IOException;
 
+/**
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
+ */
+@Deprecated
 public class Rcc implements RccConstants {
   private static String language = "java";
   private static String destDir = ".";

src/java/org/apache/hadoop/record/compiler/generated/RccConstants.java

@@ -19,6 +19,10 @@
 
 package org.apache.hadoop.record.compiler.generated;
 
+/**
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
+ */
+@Deprecated
 public interface RccConstants {
 
   int EOF = 0;

src/java/org/apache/hadoop/record/compiler/generated/RccTokenManager.java

@@ -27,6 +27,10 @@ import java.io.FileReader;
 import java.io.FileNotFoundException;
 import java.io.IOException;
 
+/**
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
+ */
+@Deprecated
 public class RccTokenManager implements RccConstants
 {
   public  java.io.PrintStream debugStream = System.out;

src/java/org/apache/hadoop/record/compiler/generated/SimpleCharStream.java

@@ -22,8 +22,10 @@ package org.apache.hadoop.record.compiler.generated;
 /**
  * An implementation of interface CharStream, where the stream is assumed to
  * contain only ASCII characters (without unicode processing).
+ * 
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
  */
-
+@Deprecated
 public class SimpleCharStream
 {
   public static final boolean staticFlag = false;

src/java/org/apache/hadoop/record/compiler/generated/Token.java

@@ -21,8 +21,10 @@ package org.apache.hadoop.record.compiler.generated;
 
 /**
  * Describes the input token stream.
+ * 
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
  */
-
+@Deprecated
 public class Token {
 
   /**

src/java/org/apache/hadoop/record/compiler/generated/TokenMgrError.java

@@ -19,6 +19,10 @@
 
 package org.apache.hadoop.record.compiler.generated;
 
+/**
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
+ */
+@Deprecated
 public class TokenMgrError extends Error
 {
   /*

src/java/org/apache/hadoop/record/compiler/generated/package.html

@@ -22,8 +22,14 @@
     <title>Hadoop Record Compiler: Parser</title>
   </head>
   <body>
-  This package contains code generated by JavaCC from the
-  Hadoop record syntax file rcc.jj. For details about the
-  record file syntax please @see org.apache.hadoop.record.
+    <p>
+    (DEPRECATED) This package contains code generated by JavaCC from the
+    Hadoop record syntax file rcc.jj. For details about the
+    record file syntax please @see org.apache.hadoop.record.
+    </p>
+  
+    <p>
+    DEPRECATED: Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
+    </p>
   </body>
 </html>

src/java/org/apache/hadoop/record/compiler/package.html

@@ -22,10 +22,16 @@
     <title>Hadoop Record Compiler</title>
   </head>
   <body>
-  This package contains classes needed for code generation
-  from the hadoop record compiler. CppGenerator and JavaGenerator
-  are the main entry points from the parser. There are classes
-  corrsponding to every primitive type and compound type
-  included in Hadoop record I/O syntax.
+    <p>
+    (DEPRECATED) This package contains classes needed for code generation
+    from the hadoop record compiler. CppGenerator and JavaGenerator
+    are the main entry points from the parser. There are classes
+    corrsponding to every primitive type and compound type
+    included in Hadoop record I/O syntax.
+    </p>
+    
+    <p>
+    DEPRECATED: Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
+    </p>
   </body>
 </html>

src/java/org/apache/hadoop/record/meta/FieldTypeInfo.java

@@ -25,7 +25,10 @@ import org.apache.hadoop.record.RecordOutput;
 /** 
  * Represents a type information for a field, which is made up of its 
  * ID (name) and its type (a TypeID object).
+ * 
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
  */
+@Deprecated
 public class FieldTypeInfo
 {
 

src/java/org/apache/hadoop/record/meta/MapTypeID.java

@@ -25,7 +25,10 @@ import org.apache.hadoop.record.RecordOutput;
 
 /** 
  * Represents typeID for a Map 
+ * 
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
  */
+@Deprecated
 public class MapTypeID extends TypeID {
   
   private TypeID typeIDKey; 

src/java/org/apache/hadoop/record/meta/RecordTypeInfo.java

@@ -30,7 +30,10 @@ import org.apache.hadoop.record.RecordOutput;
  * 
  * Type information for a record comprises metadata about the record, 
  * as well as a collection of type information for each field in the record. 
+ * 
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
  */
+@Deprecated
 public class RecordTypeInfo extends org.apache.hadoop.record.Record 
 {
 

src/java/org/apache/hadoop/record/meta/StructTypeID.java

@@ -26,7 +26,10 @@ import org.apache.hadoop.record.RecordOutput;
 
 /** 
  * Represents typeID for a struct 
+ * 
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
  */
+@Deprecated
 public class StructTypeID extends TypeID {
   private ArrayList<FieldTypeInfo> typeInfos = new ArrayList<FieldTypeInfo>();
   

src/java/org/apache/hadoop/record/meta/TypeID.java

@@ -22,8 +22,11 @@ import java.io.IOException;
 import org.apache.hadoop.record.RecordOutput;
 
 /** 
- * Represents typeID for basic types. 
+ * Represents typeID for basic types.
+ *  
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
  */
+@Deprecated
 public class TypeID {
 
   /**

src/java/org/apache/hadoop/record/meta/Utils.java

@@ -24,7 +24,10 @@ import org.apache.hadoop.record.RecordInput;
 
 /**
  * Various utility functions for Hadooop record I/O platform.
+ * 
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
  */
+@Deprecated
 public class Utils {
   
   /** Cannot create a new instance of Utils */

src/java/org/apache/hadoop/record/meta/VectorTypeID.java

@@ -24,7 +24,9 @@ import org.apache.hadoop.record.RecordOutput;
 
 /** 
  * Represents typeID for vector. 
+ * @deprecated Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
  */
+@Deprecated
 public class VectorTypeID extends TypeID {
   private TypeID typeIDElement; 
   

src/java/org/apache/hadoop/record/package.html

@@ -22,9 +22,15 @@
     <title>Hadoop Record I/O</title>
   </head>
   <body>
-  Hadoop record I/O contains classes and a record description language
-  translator for simplifying serialization and deserialization of records in a
-  language-neutral manner.
+    <p>
+    (DEPRECATED) Hadoop record I/O contains classes and a record description language
+    translator for simplifying serialization and deserialization of records in a
+    language-neutral manner.
+    </p>
+    
+    <p>
+    DEPRECATED: Replaced by <a href="http://hadoop.apache.org/avro/">Avro</a>.
+    </p>
   
   <h2>Introduction</h2>