Apache
/
hbase
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix javadoc for column family parameter in HCD 

git-svn-id: https://svn.apache.org/repos/asf/hadoop/hbase/trunk@700228 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Michael Stack 2008-09-29 19:58:50 +00:00
parent 6be90b30d9
commit c3542a31ed
1 changed files with 14 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
src/java/org/apache/hadoop/hbase/HColumnDescriptor.java
View File

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