Return-Path: Delivered-To: apmail-hadoop-hbase-commits-archive@locus.apache.org Received: (qmail 64162 invoked from network); 29 Sep 2008 19:59:11 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.2) by minotaur.apache.org with SMTP; 29 Sep 2008 19:59:11 -0000 Received: (qmail 75643 invoked by uid 500); 29 Sep 2008 19:59:10 -0000 Delivered-To: apmail-hadoop-hbase-commits-archive@hadoop.apache.org Received: (qmail 75625 invoked by uid 500); 29 Sep 2008 19:59:10 -0000 Mailing-List: contact hbase-commits-help@hadoop.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: hbase-dev@hadoop.apache.org Delivered-To: mailing list hbase-commits@hadoop.apache.org Received: (qmail 75616 invoked by uid 99); 29 Sep 2008 19:59:10 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 29 Sep 2008 12:59:10 -0700 X-ASF-Spam-Status: No, hits=-2000.0 required=10.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 29 Sep 2008 19:58:16 +0000 Received: by eris.apache.org (Postfix, from userid 65534) id 15F7A238889E; Mon, 29 Sep 2008 12:58:51 -0700 (PDT) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r700228 - /hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/HColumnDescriptor.java Date: Mon, 29 Sep 2008 19:58:50 -0000 To: hbase-commits@hadoop.apache.org From: stack@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20080929195851.15F7A238889E@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Author: stack Date: Mon Sep 29 12:58:50 2008 New Revision: 700228 URL: http://svn.apache.org/viewvc?rev=700228&view=rev Log: Fix javadoc for column family parameter in HCD Modified: hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/HColumnDescriptor.java Modified: hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/HColumnDescriptor.java URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/HColumnDescriptor.java?rev=700228&r1=700227&r2=700228&view=diff ============================================================================== --- hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/HColumnDescriptor.java (original) +++ hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/HColumnDescriptor.java Mon Sep 29 12:58:50 2008 @@ -131,21 +131,23 @@ * Construct a column descriptor specifying only the family name * The other attributes are defaulted. * - * @param columnName - column family name + * @param familyName Column family name. Must be 'printable' -- digit or + * letter -- and end in a

:
    */
-  public HColumnDescriptor(final String columnName) {
-    this(Bytes.toBytes(columnName));
+  public HColumnDescriptor(final String familyName) {
+    this(Bytes.toBytes(familyName));
   }
   
   /**
    * Construct a column descriptor specifying only the family name 
    * The other attributes are defaulted.
    * 
-   * @param columnName Column family name.  Must have the ':' ending.
+   * @param familyName Column family name. Must be 'printable' -- digit or
+   * letter -- and end in a :
    */
-  public HColumnDescriptor(final byte [] columnName) {
-    this (columnName == null || columnName.length <= 0?
-      HConstants.EMPTY_BYTE_ARRAY: columnName, DEFAULT_VERSIONS,
+  public HColumnDescriptor(final byte [] familyName) {
+    this (familyName == null || familyName.length <= 0?
+      HConstants.EMPTY_BYTE_ARRAY: familyName, DEFAULT_VERSIONS,
       DEFAULT_COMPRESSION, DEFAULT_IN_MEMORY, DEFAULT_BLOCKCACHE,
       Integer.MAX_VALUE, DEFAULT_TTL, false);
   }
@@ -167,7 +169,8 @@
 
   /**
    * Constructor
-   * @param columnName Column family name.  Must have the ':' ending.
+   * @param familyName Column family name. Must be 'printable' -- digit or
+   * letter -- and end in a :
    * @param maxVersions Maximum number of versions to keep
    * @param compression Compression type
    * @param inMemory If true, column data should be kept in an HRegionServer's
@@ -183,12 +186,12 @@
    * end in a :
    * @throws IllegalArgumentException if the number of versions is <= 0
    */
-  public HColumnDescriptor(final byte [] columnName, final int maxVersions,
+  public HColumnDescriptor(final byte [] familyName, final int maxVersions,
       final CompressionType compression, final boolean inMemory,
       final boolean blockCacheEnabled, final int maxValueLength,
       final int timeToLive, final boolean bloomFilter) {
-    isLegalFamilyName(columnName);
-    this.name = stripColon(columnName);
+    isLegalFamilyName(familyName);
+    this.name = stripColon(familyName);
     if (maxVersions <= 0) {
       // TODO: Allow maxVersion of 0 to be the way you say "Keep all versions".
       // Until there is support, consider 0 or < 0 -- a configuration error.