http://git-wip-us.apache.org/repos/asf/hbase-site/blob/f391bcef/devapidocs/src-html/org/apache/hadoop/hbase/client/ColumnFamilyDescriptor.html
----------------------------------------------------------------------
diff --git
a/devapidocs/src-html/org/apache/hadoop/hbase/client/ColumnFamilyDescriptor.html
b/devapidocs/src-html/org/apache/hadoop/hbase/client/ColumnFamilyDescriptor.html
index 0683e6c..91fe6e6 100644
---
a/devapidocs/src-html/org/apache/hadoop/hbase/client/ColumnFamilyDescriptor.html
+++
b/devapidocs/src-html/org/apache/hadoop/hbase/client/ColumnFamilyDescriptor.html
@@ -40,188 +40,190 @@
<span class="sourceLineNo">032</span> * number of versions, compression
settings, etc.<a name="line.32"></a>
<span class="sourceLineNo">033</span> *<a name="line.33"></a>
<span class="sourceLineNo">034</span> * It is used as input when creating a
table or adding a column.<a name="line.34"></a>
-<span class="sourceLineNo">035</span> */<a name="line.35"></a>
-<span class="sourceLineNo">036</span>@InterfaceAudience.Public<a
name="line.36"></a>
-<span class="sourceLineNo">037</span>public interface ColumnFamilyDescriptor
{<a name="line.37"></a>
-<span class="sourceLineNo">038</span><a name="line.38"></a>
-<span class="sourceLineNo">039</span> @InterfaceAudience.Private<a
name="line.39"></a>
-<span class="sourceLineNo">040</span> static final
Comparator<ColumnFamilyDescriptor> COMPARATOR<a name="line.40"></a>
-<span class="sourceLineNo">041</span> = (ColumnFamilyDescriptor lhs,
ColumnFamilyDescriptor rhs) -> {<a name="line.41"></a>
-<span class="sourceLineNo">042</span> int result =
Bytes.compareTo(lhs.getName(), rhs.getName());<a name="line.42"></a>
-<span class="sourceLineNo">043</span> if (result != 0) {<a
name="line.43"></a>
-<span class="sourceLineNo">044</span> return result;<a name="line.44"></a>
-<span class="sourceLineNo">045</span> }<a name="line.45"></a>
-<span class="sourceLineNo">046</span> // punt on comparison for ordering,
just calculate difference.<a name="line.46"></a>
-<span class="sourceLineNo">047</span> result = lhs.getValues().hashCode() -
rhs.getValues().hashCode();<a name="line.47"></a>
-<span class="sourceLineNo">048</span> if (result != 0) {<a
name="line.48"></a>
-<span class="sourceLineNo">049</span> return result;<a name="line.49"></a>
-<span class="sourceLineNo">050</span> }<a name="line.50"></a>
-<span class="sourceLineNo">051</span> return
lhs.getConfiguration().hashCode() - rhs.getConfiguration().hashCode();<a
name="line.51"></a>
-<span class="sourceLineNo">052</span> };<a name="line.52"></a>
-<span class="sourceLineNo">053</span><a name="line.53"></a>
-<span class="sourceLineNo">054</span> /**<a name="line.54"></a>
-<span class="sourceLineNo">055</span> * @return The storefile/hfile
blocksize for this column family.<a name="line.55"></a>
-<span class="sourceLineNo">056</span> */<a name="line.56"></a>
-<span class="sourceLineNo">057</span> int getBlocksize();<a
name="line.57"></a>
-<span class="sourceLineNo">058</span> /**<a name="line.58"></a>
-<span class="sourceLineNo">059</span> * @return bloom filter type used for
new StoreFiles in ColumnFamily<a name="line.59"></a>
-<span class="sourceLineNo">060</span> */<a name="line.60"></a>
-<span class="sourceLineNo">061</span> BloomType getBloomFilterType();<a
name="line.61"></a>
-<span class="sourceLineNo">062</span><a name="line.62"></a>
-<span class="sourceLineNo">063</span> /**<a name="line.63"></a>
-<span class="sourceLineNo">064</span> * @return Compression type setting.<a
name="line.64"></a>
-<span class="sourceLineNo">065</span> */<a name="line.65"></a>
-<span class="sourceLineNo">066</span> Compression.Algorithm
getCompactionCompressionType();<a name="line.66"></a>
-<span class="sourceLineNo">067</span> /**<a name="line.67"></a>
-<span class="sourceLineNo">068</span> * @return Compression type setting.<a
name="line.68"></a>
-<span class="sourceLineNo">069</span> */<a name="line.69"></a>
-<span class="sourceLineNo">070</span> Compression.Algorithm
getCompressionType();<a name="line.70"></a>
-<span class="sourceLineNo">071</span> /**<a name="line.71"></a>
-<span class="sourceLineNo">072</span> * @return an unmodifiable map.<a
name="line.72"></a>
-<span class="sourceLineNo">073</span> */<a name="line.73"></a>
-<span class="sourceLineNo">074</span> Map<String, String>
getConfiguration();<a name="line.74"></a>
-<span class="sourceLineNo">075</span> /**<a name="line.75"></a>
-<span class="sourceLineNo">076</span> * @param key the key whose associated
value is to be returned<a name="line.76"></a>
-<span class="sourceLineNo">077</span> * @return accessing the configuration
value by key.<a name="line.77"></a>
-<span class="sourceLineNo">078</span> */<a name="line.78"></a>
-<span class="sourceLineNo">079</span> String getConfigurationValue(String
key);<a name="line.79"></a>
-<span class="sourceLineNo">080</span> /**<a name="line.80"></a>
-<span class="sourceLineNo">081</span> * @return replication factor set for
this CF<a name="line.81"></a>
-<span class="sourceLineNo">082</span> */<a name="line.82"></a>
-<span class="sourceLineNo">083</span> short getDFSReplication();<a
name="line.83"></a>
-<span class="sourceLineNo">084</span> /**<a name="line.84"></a>
-<span class="sourceLineNo">085</span> * @return the data block encoding
algorithm used in block cache and<a name="line.85"></a>
-<span class="sourceLineNo">086</span> * optionally on disk<a
name="line.86"></a>
-<span class="sourceLineNo">087</span> */<a name="line.87"></a>
-<span class="sourceLineNo">088</span> DataBlockEncoding
getDataBlockEncoding();<a name="line.88"></a>
-<span class="sourceLineNo">089</span> /**<a name="line.89"></a>
-<span class="sourceLineNo">090</span> * @return Return the raw crypto key
attribute for the family, or null if not set<a name="line.90"></a>
-<span class="sourceLineNo">091</span> */<a name="line.91"></a>
-<span class="sourceLineNo">092</span> byte[] getEncryptionKey();<a
name="line.92"></a>
-<span class="sourceLineNo">093</span><a name="line.93"></a>
-<span class="sourceLineNo">094</span> /**<a name="line.94"></a>
-<span class="sourceLineNo">095</span> * @return Return the encryption
algorithm in use by this family<a name="line.95"></a>
-<span class="sourceLineNo">096</span> */<a name="line.96"></a>
-<span class="sourceLineNo">097</span> String getEncryptionType();<a
name="line.97"></a>
-<span class="sourceLineNo">098</span> /**<a name="line.98"></a>
-<span class="sourceLineNo">099</span> * @return in-memory compaction policy
if set for the cf. Returns null if no policy is set for<a name="line.99"></a>
-<span class="sourceLineNo">100</span> * for this column family<a
name="line.100"></a>
-<span class="sourceLineNo">101</span> */<a name="line.101"></a>
-<span class="sourceLineNo">102</span> MemoryCompactionPolicy
getInMemoryCompaction();<a name="line.102"></a>
-<span class="sourceLineNo">103</span> /**<a name="line.103"></a>
-<span class="sourceLineNo">104</span> * @return return the
KeepDeletedCells<a name="line.104"></a>
-<span class="sourceLineNo">105</span> */<a name="line.105"></a>
-<span class="sourceLineNo">106</span> KeepDeletedCells
getKeepDeletedCells();<a name="line.106"></a>
-<span class="sourceLineNo">107</span> /**<a name="line.107"></a>
-<span class="sourceLineNo">108</span> * @return maximum number of versions<a
name="line.108"></a>
-<span class="sourceLineNo">109</span> */<a name="line.109"></a>
-<span class="sourceLineNo">110</span> int getMaxVersions();<a
name="line.110"></a>
-<span class="sourceLineNo">111</span> /**<a name="line.111"></a>
-<span class="sourceLineNo">112</span> * @return The minimum number of
versions to keep.<a name="line.112"></a>
-<span class="sourceLineNo">113</span> */<a name="line.113"></a>
-<span class="sourceLineNo">114</span> int getMinVersions();<a
name="line.114"></a>
-<span class="sourceLineNo">115</span> /**<a name="line.115"></a>
-<span class="sourceLineNo">116</span> * Get the mob compact partition policy
for this family<a name="line.116"></a>
-<span class="sourceLineNo">117</span> * @return MobCompactPartitionPolicy<a
name="line.117"></a>
-<span class="sourceLineNo">118</span> */<a name="line.118"></a>
-<span class="sourceLineNo">119</span> MobCompactPartitionPolicy
getMobCompactPartitionPolicy();<a name="line.119"></a>
-<span class="sourceLineNo">120</span> /**<a name="line.120"></a>
-<span class="sourceLineNo">121</span> * Gets the mob threshold of the
family.<a name="line.121"></a>
-<span class="sourceLineNo">122</span> * If the size of a cell value is
larger than this threshold, it's regarded as a mob.<a name="line.122"></a>
-<span class="sourceLineNo">123</span> * The default threshold is
1024*100(100K)B.<a name="line.123"></a>
-<span class="sourceLineNo">124</span> * @return The mob threshold.<a
name="line.124"></a>
-<span class="sourceLineNo">125</span> */<a name="line.125"></a>
-<span class="sourceLineNo">126</span> long getMobThreshold();<a
name="line.126"></a>
-<span class="sourceLineNo">127</span> /**<a name="line.127"></a>
-<span class="sourceLineNo">128</span> * @return a copy of Name of this
column family<a name="line.128"></a>
-<span class="sourceLineNo">129</span> */<a name="line.129"></a>
-<span class="sourceLineNo">130</span> byte[] getName();<a name="line.130"></a>
-<span class="sourceLineNo">131</span><a name="line.131"></a>
-<span class="sourceLineNo">132</span> /**<a name="line.132"></a>
-<span class="sourceLineNo">133</span> * @return Name of this column family<a
name="line.133"></a>
-<span class="sourceLineNo">134</span> */<a name="line.134"></a>
-<span class="sourceLineNo">135</span> String getNameAsString();<a
name="line.135"></a>
-<span class="sourceLineNo">136</span><a name="line.136"></a>
-<span class="sourceLineNo">137</span> /**<a name="line.137"></a>
-<span class="sourceLineNo">138</span> * @return the scope tag<a
name="line.138"></a>
-<span class="sourceLineNo">139</span> */<a name="line.139"></a>
-<span class="sourceLineNo">140</span> int getScope();<a name="line.140"></a>
-<span class="sourceLineNo">141</span> /**<a name="line.141"></a>
-<span class="sourceLineNo">142</span> * Not using {@code enum} here because
HDFS is not using {@code enum} for storage policy, see<a name="line.142"></a>
-<span class="sourceLineNo">143</span> *
org.apache.hadoop.hdfs.server.blockmanagement.BlockStoragePolicySuite for more
details.<a name="line.143"></a>
-<span class="sourceLineNo">144</span> * @return Return the storage policy in
use by this family<a name="line.144"></a>
-<span class="sourceLineNo">145</span> */<a name="line.145"></a>
-<span class="sourceLineNo">146</span> String getStoragePolicy();<a
name="line.146"></a>
-<span class="sourceLineNo">147</span> /**<a name="line.147"></a>
-<span class="sourceLineNo">148</span> * @return Time-to-live of cell
contents, in seconds.<a name="line.148"></a>
-<span class="sourceLineNo">149</span> */<a name="line.149"></a>
-<span class="sourceLineNo">150</span> int getTimeToLive();<a
name="line.150"></a>
-<span class="sourceLineNo">151</span> /**<a name="line.151"></a>
-<span class="sourceLineNo">152</span> * @param key The key.<a
name="line.152"></a>
-<span class="sourceLineNo">153</span> * @return A clone value. Null if no
mapping for the key<a name="line.153"></a>
-<span class="sourceLineNo">154</span> */<a name="line.154"></a>
-<span class="sourceLineNo">155</span> Bytes getValue(Bytes key);<a
name="line.155"></a>
-<span class="sourceLineNo">156</span> /**<a name="line.156"></a>
-<span class="sourceLineNo">157</span> * @param key The key.<a
name="line.157"></a>
-<span class="sourceLineNo">158</span> * @return A clone value. Null if no
mapping for the key<a name="line.158"></a>
-<span class="sourceLineNo">159</span> */<a name="line.159"></a>
-<span class="sourceLineNo">160</span> byte[] getValue(byte[] key);<a
name="line.160"></a>
-<span class="sourceLineNo">161</span> /**<a name="line.161"></a>
-<span class="sourceLineNo">162</span> * It clone all bytes of all
elements.<a name="line.162"></a>
-<span class="sourceLineNo">163</span> * @return All values<a
name="line.163"></a>
-<span class="sourceLineNo">164</span> */<a name="line.164"></a>
-<span class="sourceLineNo">165</span> Map<Bytes, Bytes> getValues();<a
name="line.165"></a>
-<span class="sourceLineNo">166</span> /**<a name="line.166"></a>
-<span class="sourceLineNo">167</span> * @return True if hfile DATA type
blocks should be cached (You cannot disable caching of INDEX<a
name="line.167"></a>
-<span class="sourceLineNo">168</span> * and BLOOM type blocks).<a
name="line.168"></a>
-<span class="sourceLineNo">169</span> */<a name="line.169"></a>
-<span class="sourceLineNo">170</span> boolean isBlockCacheEnabled();<a
name="line.170"></a>
-<span class="sourceLineNo">171</span> /**<a name="line.171"></a>
-<span class="sourceLineNo">172</span> * @return true if we should cache
bloomfilter blocks on write<a name="line.172"></a>
-<span class="sourceLineNo">173</span> */<a name="line.173"></a>
-<span class="sourceLineNo">174</span> boolean isCacheBloomsOnWrite();<a
name="line.174"></a>
-<span class="sourceLineNo">175</span> /**<a name="line.175"></a>
-<span class="sourceLineNo">176</span> * @return true if we should cache data
blocks in the L1 cache (if block cache deploy has more<a name="line.176"></a>
-<span class="sourceLineNo">177</span> * than one tier; e.g. we are
using CombinedBlockCache).<a name="line.177"></a>
-<span class="sourceLineNo">178</span> */<a name="line.178"></a>
-<span class="sourceLineNo">179</span> boolean isCacheDataInL1();<a
name="line.179"></a>
-<span class="sourceLineNo">180</span> /**<a name="line.180"></a>
-<span class="sourceLineNo">181</span> * @return true if we should cache data
blocks on write<a name="line.181"></a>
-<span class="sourceLineNo">182</span> */<a name="line.182"></a>
-<span class="sourceLineNo">183</span> boolean isCacheDataOnWrite();<a
name="line.183"></a>
-<span class="sourceLineNo">184</span> /**<a name="line.184"></a>
-<span class="sourceLineNo">185</span> * @return true if we should cache
index blocks on write<a name="line.185"></a>
-<span class="sourceLineNo">186</span> */<a name="line.186"></a>
-<span class="sourceLineNo">187</span> boolean isCacheIndexesOnWrite();<a
name="line.187"></a>
-<span class="sourceLineNo">188</span> /**<a name="line.188"></a>
-<span class="sourceLineNo">189</span> * @return Whether KV tags should be
compressed along with DataBlockEncoding. When no<a name="line.189"></a>
-<span class="sourceLineNo">190</span> * DataBlockEncoding is been
used, this is having no effect.<a name="line.190"></a>
-<span class="sourceLineNo">191</span> */<a name="line.191"></a>
-<span class="sourceLineNo">192</span> boolean isCompressTags();<a
name="line.192"></a>
-<span class="sourceLineNo">193</span> /**<a name="line.193"></a>
-<span class="sourceLineNo">194</span> * @return true if we should evict
cached blocks from the blockcache on close<a name="line.194"></a>
-<span class="sourceLineNo">195</span> */<a name="line.195"></a>
-<span class="sourceLineNo">196</span> boolean isEvictBlocksOnClose();<a
name="line.196"></a>
-<span class="sourceLineNo">197</span> /**<a name="line.197"></a>
-<span class="sourceLineNo">198</span> * @return True if we are to favor
keeping all values for this column family in the<a name="line.198"></a>
-<span class="sourceLineNo">199</span> * HRegionServer cache.<a
name="line.199"></a>
-<span class="sourceLineNo">200</span> */<a name="line.200"></a>
-<span class="sourceLineNo">201</span> boolean isInMemory();<a
name="line.201"></a>
-<span class="sourceLineNo">202</span> /**<a name="line.202"></a>
-<span class="sourceLineNo">203</span> * Gets whether the mob is enabled for
the family.<a name="line.203"></a>
-<span class="sourceLineNo">204</span> * @return True if the mob is enabled
for the family.<a name="line.204"></a>
-<span class="sourceLineNo">205</span> */<a name="line.205"></a>
-<span class="sourceLineNo">206</span> boolean isMobEnabled();<a
name="line.206"></a>
-<span class="sourceLineNo">207</span> /**<a name="line.207"></a>
-<span class="sourceLineNo">208</span> * @return true if we should prefetch
blocks into the blockcache on open<a name="line.208"></a>
-<span class="sourceLineNo">209</span> */<a name="line.209"></a>
-<span class="sourceLineNo">210</span> boolean isPrefetchBlocksOnOpen();<a
name="line.210"></a>
-<span class="sourceLineNo">211</span><a name="line.211"></a>
-<span class="sourceLineNo">212</span> /**<a name="line.212"></a>
-<span class="sourceLineNo">213</span> * @return Column family descriptor
with only the customized attributes.<a name="line.213"></a>
-<span class="sourceLineNo">214</span> */<a name="line.214"></a>
-<span class="sourceLineNo">215</span> String toStringCustomizedValues();<a
name="line.215"></a>
-<span class="sourceLineNo">216</span>}<a name="line.216"></a>
+<span class="sourceLineNo">035</span> *<a name="line.35"></a>
+<span class="sourceLineNo">036</span> * To construct a new instance, use the
{@link ColumnFamilyDescriptorBuilder} methods<a name="line.36"></a>
+<span class="sourceLineNo">037</span> */<a name="line.37"></a>
+<span class="sourceLineNo">038</span>@InterfaceAudience.Public<a
name="line.38"></a>
+<span class="sourceLineNo">039</span>public interface ColumnFamilyDescriptor
{<a name="line.39"></a>
+<span class="sourceLineNo">040</span><a name="line.40"></a>
+<span class="sourceLineNo">041</span> @InterfaceAudience.Private<a
name="line.41"></a>
+<span class="sourceLineNo">042</span> static final
Comparator<ColumnFamilyDescriptor> COMPARATOR<a name="line.42"></a>
+<span class="sourceLineNo">043</span> = (ColumnFamilyDescriptor lhs,
ColumnFamilyDescriptor rhs) -> {<a name="line.43"></a>
+<span class="sourceLineNo">044</span> int result =
Bytes.compareTo(lhs.getName(), rhs.getName());<a name="line.44"></a>
+<span class="sourceLineNo">045</span> if (result != 0) {<a
name="line.45"></a>
+<span class="sourceLineNo">046</span> return result;<a name="line.46"></a>
+<span class="sourceLineNo">047</span> }<a name="line.47"></a>
+<span class="sourceLineNo">048</span> // punt on comparison for ordering,
just calculate difference.<a name="line.48"></a>
+<span class="sourceLineNo">049</span> result = lhs.getValues().hashCode() -
rhs.getValues().hashCode();<a name="line.49"></a>
+<span class="sourceLineNo">050</span> if (result != 0) {<a
name="line.50"></a>
+<span class="sourceLineNo">051</span> return result;<a name="line.51"></a>
+<span class="sourceLineNo">052</span> }<a name="line.52"></a>
+<span class="sourceLineNo">053</span> return
lhs.getConfiguration().hashCode() - rhs.getConfiguration().hashCode();<a
name="line.53"></a>
+<span class="sourceLineNo">054</span> };<a name="line.54"></a>
+<span class="sourceLineNo">055</span><a name="line.55"></a>
+<span class="sourceLineNo">056</span> /**<a name="line.56"></a>
+<span class="sourceLineNo">057</span> * @return The storefile/hfile
blocksize for this column family.<a name="line.57"></a>
+<span class="sourceLineNo">058</span> */<a name="line.58"></a>
+<span class="sourceLineNo">059</span> int getBlocksize();<a
name="line.59"></a>
+<span class="sourceLineNo">060</span> /**<a name="line.60"></a>
+<span class="sourceLineNo">061</span> * @return bloom filter type used for
new StoreFiles in ColumnFamily<a name="line.61"></a>
+<span class="sourceLineNo">062</span> */<a name="line.62"></a>
+<span class="sourceLineNo">063</span> BloomType getBloomFilterType();<a
name="line.63"></a>
+<span class="sourceLineNo">064</span><a name="line.64"></a>
+<span class="sourceLineNo">065</span> /**<a name="line.65"></a>
+<span class="sourceLineNo">066</span> * @return Compression type setting.<a
name="line.66"></a>
+<span class="sourceLineNo">067</span> */<a name="line.67"></a>
+<span class="sourceLineNo">068</span> Compression.Algorithm
getCompactionCompressionType();<a name="line.68"></a>
+<span class="sourceLineNo">069</span> /**<a name="line.69"></a>
+<span class="sourceLineNo">070</span> * @return Compression type setting.<a
name="line.70"></a>
+<span class="sourceLineNo">071</span> */<a name="line.71"></a>
+<span class="sourceLineNo">072</span> Compression.Algorithm
getCompressionType();<a name="line.72"></a>
+<span class="sourceLineNo">073</span> /**<a name="line.73"></a>
+<span class="sourceLineNo">074</span> * @return an unmodifiable map.<a
name="line.74"></a>
+<span class="sourceLineNo">075</span> */<a name="line.75"></a>
+<span class="sourceLineNo">076</span> Map<String, String>
getConfiguration();<a name="line.76"></a>
+<span class="sourceLineNo">077</span> /**<a name="line.77"></a>
+<span class="sourceLineNo">078</span> * @param key the key whose associated
value is to be returned<a name="line.78"></a>
+<span class="sourceLineNo">079</span> * @return accessing the configuration
value by key.<a name="line.79"></a>
+<span class="sourceLineNo">080</span> */<a name="line.80"></a>
+<span class="sourceLineNo">081</span> String getConfigurationValue(String
key);<a name="line.81"></a>
+<span class="sourceLineNo">082</span> /**<a name="line.82"></a>
+<span class="sourceLineNo">083</span> * @return replication factor set for
this CF<a name="line.83"></a>
+<span class="sourceLineNo">084</span> */<a name="line.84"></a>
+<span class="sourceLineNo">085</span> short getDFSReplication();<a
name="line.85"></a>
+<span class="sourceLineNo">086</span> /**<a name="line.86"></a>
+<span class="sourceLineNo">087</span> * @return the data block encoding
algorithm used in block cache and<a name="line.87"></a>
+<span class="sourceLineNo">088</span> * optionally on disk<a
name="line.88"></a>
+<span class="sourceLineNo">089</span> */<a name="line.89"></a>
+<span class="sourceLineNo">090</span> DataBlockEncoding
getDataBlockEncoding();<a name="line.90"></a>
+<span class="sourceLineNo">091</span> /**<a name="line.91"></a>
+<span class="sourceLineNo">092</span> * @return Return the raw crypto key
attribute for the family, or null if not set<a name="line.92"></a>
+<span class="sourceLineNo">093</span> */<a name="line.93"></a>
+<span class="sourceLineNo">094</span> byte[] getEncryptionKey();<a
name="line.94"></a>
+<span class="sourceLineNo">095</span><a name="line.95"></a>
+<span class="sourceLineNo">096</span> /**<a name="line.96"></a>
+<span class="sourceLineNo">097</span> * @return Return the encryption
algorithm in use by this family<a name="line.97"></a>
+<span class="sourceLineNo">098</span> */<a name="line.98"></a>
+<span class="sourceLineNo">099</span> String getEncryptionType();<a
name="line.99"></a>
+<span class="sourceLineNo">100</span> /**<a name="line.100"></a>
+<span class="sourceLineNo">101</span> * @return in-memory compaction policy
if set for the cf. Returns null if no policy is set for<a name="line.101"></a>
+<span class="sourceLineNo">102</span> * for this column family<a
name="line.102"></a>
+<span class="sourceLineNo">103</span> */<a name="line.103"></a>
+<span class="sourceLineNo">104</span> MemoryCompactionPolicy
getInMemoryCompaction();<a name="line.104"></a>
+<span class="sourceLineNo">105</span> /**<a name="line.105"></a>
+<span class="sourceLineNo">106</span> * @return return the
KeepDeletedCells<a name="line.106"></a>
+<span class="sourceLineNo">107</span> */<a name="line.107"></a>
+<span class="sourceLineNo">108</span> KeepDeletedCells
getKeepDeletedCells();<a name="line.108"></a>
+<span class="sourceLineNo">109</span> /**<a name="line.109"></a>
+<span class="sourceLineNo">110</span> * @return maximum number of versions<a
name="line.110"></a>
+<span class="sourceLineNo">111</span> */<a name="line.111"></a>
+<span class="sourceLineNo">112</span> int getMaxVersions();<a
name="line.112"></a>
+<span class="sourceLineNo">113</span> /**<a name="line.113"></a>
+<span class="sourceLineNo">114</span> * @return The minimum number of
versions to keep.<a name="line.114"></a>
+<span class="sourceLineNo">115</span> */<a name="line.115"></a>
+<span class="sourceLineNo">116</span> int getMinVersions();<a
name="line.116"></a>
+<span class="sourceLineNo">117</span> /**<a name="line.117"></a>
+<span class="sourceLineNo">118</span> * Get the mob compact partition policy
for this family<a name="line.118"></a>
+<span class="sourceLineNo">119</span> * @return MobCompactPartitionPolicy<a
name="line.119"></a>
+<span class="sourceLineNo">120</span> */<a name="line.120"></a>
+<span class="sourceLineNo">121</span> MobCompactPartitionPolicy
getMobCompactPartitionPolicy();<a name="line.121"></a>
+<span class="sourceLineNo">122</span> /**<a name="line.122"></a>
+<span class="sourceLineNo">123</span> * Gets the mob threshold of the
family.<a name="line.123"></a>
+<span class="sourceLineNo">124</span> * If the size of a cell value is
larger than this threshold, it's regarded as a mob.<a name="line.124"></a>
+<span class="sourceLineNo">125</span> * The default threshold is
1024*100(100K)B.<a name="line.125"></a>
+<span class="sourceLineNo">126</span> * @return The mob threshold.<a
name="line.126"></a>
+<span class="sourceLineNo">127</span> */<a name="line.127"></a>
+<span class="sourceLineNo">128</span> long getMobThreshold();<a
name="line.128"></a>
+<span class="sourceLineNo">129</span> /**<a name="line.129"></a>
+<span class="sourceLineNo">130</span> * @return a copy of Name of this
column family<a name="line.130"></a>
+<span class="sourceLineNo">131</span> */<a name="line.131"></a>
+<span class="sourceLineNo">132</span> byte[] getName();<a name="line.132"></a>
+<span class="sourceLineNo">133</span><a name="line.133"></a>
+<span class="sourceLineNo">134</span> /**<a name="line.134"></a>
+<span class="sourceLineNo">135</span> * @return Name of this column family<a
name="line.135"></a>
+<span class="sourceLineNo">136</span> */<a name="line.136"></a>
+<span class="sourceLineNo">137</span> String getNameAsString();<a
name="line.137"></a>
+<span class="sourceLineNo">138</span><a name="line.138"></a>
+<span class="sourceLineNo">139</span> /**<a name="line.139"></a>
+<span class="sourceLineNo">140</span> * @return the scope tag<a
name="line.140"></a>
+<span class="sourceLineNo">141</span> */<a name="line.141"></a>
+<span class="sourceLineNo">142</span> int getScope();<a name="line.142"></a>
+<span class="sourceLineNo">143</span> /**<a name="line.143"></a>
+<span class="sourceLineNo">144</span> * Not using {@code enum} here because
HDFS is not using {@code enum} for storage policy, see<a name="line.144"></a>
+<span class="sourceLineNo">145</span> *
org.apache.hadoop.hdfs.server.blockmanagement.BlockStoragePolicySuite for more
details.<a name="line.145"></a>
+<span class="sourceLineNo">146</span> * @return Return the storage policy in
use by this family<a name="line.146"></a>
+<span class="sourceLineNo">147</span> */<a name="line.147"></a>
+<span class="sourceLineNo">148</span> String getStoragePolicy();<a
name="line.148"></a>
+<span class="sourceLineNo">149</span> /**<a name="line.149"></a>
+<span class="sourceLineNo">150</span> * @return Time-to-live of cell
contents, in seconds.<a name="line.150"></a>
+<span class="sourceLineNo">151</span> */<a name="line.151"></a>
+<span class="sourceLineNo">152</span> int getTimeToLive();<a
name="line.152"></a>
+<span class="sourceLineNo">153</span> /**<a name="line.153"></a>
+<span class="sourceLineNo">154</span> * @param key The key.<a
name="line.154"></a>
+<span class="sourceLineNo">155</span> * @return A clone value. Null if no
mapping for the key<a name="line.155"></a>
+<span class="sourceLineNo">156</span> */<a name="line.156"></a>
+<span class="sourceLineNo">157</span> Bytes getValue(Bytes key);<a
name="line.157"></a>
+<span class="sourceLineNo">158</span> /**<a name="line.158"></a>
+<span class="sourceLineNo">159</span> * @param key The key.<a
name="line.159"></a>
+<span class="sourceLineNo">160</span> * @return A clone value. Null if no
mapping for the key<a name="line.160"></a>
+<span class="sourceLineNo">161</span> */<a name="line.161"></a>
+<span class="sourceLineNo">162</span> byte[] getValue(byte[] key);<a
name="line.162"></a>
+<span class="sourceLineNo">163</span> /**<a name="line.163"></a>
+<span class="sourceLineNo">164</span> * It clone all bytes of all
elements.<a name="line.164"></a>
+<span class="sourceLineNo">165</span> * @return All values<a
name="line.165"></a>
+<span class="sourceLineNo">166</span> */<a name="line.166"></a>
+<span class="sourceLineNo">167</span> Map<Bytes, Bytes> getValues();<a
name="line.167"></a>
+<span class="sourceLineNo">168</span> /**<a name="line.168"></a>
+<span class="sourceLineNo">169</span> * @return True if hfile DATA type
blocks should be cached (You cannot disable caching of INDEX<a
name="line.169"></a>
+<span class="sourceLineNo">170</span> * and BLOOM type blocks).<a
name="line.170"></a>
+<span class="sourceLineNo">171</span> */<a name="line.171"></a>
+<span class="sourceLineNo">172</span> boolean isBlockCacheEnabled();<a
name="line.172"></a>
+<span class="sourceLineNo">173</span> /**<a name="line.173"></a>
+<span class="sourceLineNo">174</span> * @return true if we should cache
bloomfilter blocks on write<a name="line.174"></a>
+<span class="sourceLineNo">175</span> */<a name="line.175"></a>
+<span class="sourceLineNo">176</span> boolean isCacheBloomsOnWrite();<a
name="line.176"></a>
+<span class="sourceLineNo">177</span> /**<a name="line.177"></a>
+<span class="sourceLineNo">178</span> * @return true if we should cache data
blocks in the L1 cache (if block cache deploy has more<a name="line.178"></a>
+<span class="sourceLineNo">179</span> * than one tier; e.g. we are
using CombinedBlockCache).<a name="line.179"></a>
+<span class="sourceLineNo">180</span> */<a name="line.180"></a>
+<span class="sourceLineNo">181</span> boolean isCacheDataInL1();<a
name="line.181"></a>
+<span class="sourceLineNo">182</span> /**<a name="line.182"></a>
+<span class="sourceLineNo">183</span> * @return true if we should cache data
blocks on write<a name="line.183"></a>
+<span class="sourceLineNo">184</span> */<a name="line.184"></a>
+<span class="sourceLineNo">185</span> boolean isCacheDataOnWrite();<a
name="line.185"></a>
+<span class="sourceLineNo">186</span> /**<a name="line.186"></a>
+<span class="sourceLineNo">187</span> * @return true if we should cache
index blocks on write<a name="line.187"></a>
+<span class="sourceLineNo">188</span> */<a name="line.188"></a>
+<span class="sourceLineNo">189</span> boolean isCacheIndexesOnWrite();<a
name="line.189"></a>
+<span class="sourceLineNo">190</span> /**<a name="line.190"></a>
+<span class="sourceLineNo">191</span> * @return Whether KV tags should be
compressed along with DataBlockEncoding. When no<a name="line.191"></a>
+<span class="sourceLineNo">192</span> * DataBlockEncoding is been
used, this is having no effect.<a name="line.192"></a>
+<span class="sourceLineNo">193</span> */<a name="line.193"></a>
+<span class="sourceLineNo">194</span> boolean isCompressTags();<a
name="line.194"></a>
+<span class="sourceLineNo">195</span> /**<a name="line.195"></a>
+<span class="sourceLineNo">196</span> * @return true if we should evict
cached blocks from the blockcache on close<a name="line.196"></a>
+<span class="sourceLineNo">197</span> */<a name="line.197"></a>
+<span class="sourceLineNo">198</span> boolean isEvictBlocksOnClose();<a
name="line.198"></a>
+<span class="sourceLineNo">199</span> /**<a name="line.199"></a>
+<span class="sourceLineNo">200</span> * @return True if we are to favor
keeping all values for this column family in the<a name="line.200"></a>
+<span class="sourceLineNo">201</span> * HRegionServer cache.<a
name="line.201"></a>
+<span class="sourceLineNo">202</span> */<a name="line.202"></a>
+<span class="sourceLineNo">203</span> boolean isInMemory();<a
name="line.203"></a>
+<span class="sourceLineNo">204</span> /**<a name="line.204"></a>
+<span class="sourceLineNo">205</span> * Gets whether the mob is enabled for
the family.<a name="line.205"></a>
+<span class="sourceLineNo">206</span> * @return True if the mob is enabled
for the family.<a name="line.206"></a>
+<span class="sourceLineNo">207</span> */<a name="line.207"></a>
+<span class="sourceLineNo">208</span> boolean isMobEnabled();<a
name="line.208"></a>
+<span class="sourceLineNo">209</span> /**<a name="line.209"></a>
+<span class="sourceLineNo">210</span> * @return true if we should prefetch
blocks into the blockcache on open<a name="line.210"></a>
+<span class="sourceLineNo">211</span> */<a name="line.211"></a>
+<span class="sourceLineNo">212</span> boolean isPrefetchBlocksOnOpen();<a
name="line.212"></a>
+<span class="sourceLineNo">213</span><a name="line.213"></a>
+<span class="sourceLineNo">214</span> /**<a name="line.214"></a>
+<span class="sourceLineNo">215</span> * @return Column family descriptor
with only the customized attributes.<a name="line.215"></a>
+<span class="sourceLineNo">216</span> */<a name="line.216"></a>
+<span class="sourceLineNo">217</span> String toStringCustomizedValues();<a
name="line.217"></a>
+<span class="sourceLineNo">218</span>}<a name="line.218"></a>
