Package org.apache.hadoop.hbase.util

Interface Summary
BloomFilter Defines the general behavior of a bloom filter.
BloomFilterBase Common methods Bloom filter methods required at read and write time.
BloomFilterWriter Specifies methods needed to add elements to a Bloom filter and serialize the resulting Bloom filter as a sequence of bytes.
ByteRange Lightweight, reusable class for specifying ranges of byte[]'s.
CancelableProgressable Similar interface as Progressable but returns a boolean to support canceling the operation.
EnvironmentEdge Has some basic interaction with the environment.
FSVisitor.LogFileVisitor  
FSVisitor.RecoveredEditsVisitor  
FSVisitor.RegionVisitor  
FSVisitor.StoreFileVisitor  
HBaseFsck.ErrorReporter  
KeyRange A key range use in split coverage.
ModifyRegionUtils.RegionEditTask  
ModifyRegionUtils.RegionFillTask  
PoolMap.Pool<R>  
PositionedByteRange Extends ByteRange with additional methods to support tracking a consumers position within the viewport.
RegionSplitter.SplitAlgorithm A generic interface for the RegionSplitter code to use for all it's functionality.
 

Class Summary
AbstractHBaseTool Common base class used for HBase command-line tools.
Addressing Utility for network addresses, resolving and naming.
ArrayUtils A set of array utility functions that return reasonable values in cases where an array is allocated or if it is null
Base64 Encodes and decodes to and from Base64 notation.
Base64.Base64InputStream A Base64.Base64InputStream will read data from another InputStream, given in the constructor, and encode/decode to/from Base64 notation on the fly.
Base64.Base64OutputStream A Base64.Base64OutputStream will write data to another OutputStream, given in the constructor, and encode/decode to/from Base64 notation on the fly.
BloomFilterFactory Handles Bloom filter initialization based on configuration and serialized metadata in the reader and writer of StoreFile.
BoundedArrayQueue<E> A bounded non-thread safe implementation of Queue.
BoundedConcurrentLinkedQueue<T> A ConcurrentLinkedQueue that enforces a maximum queue size.
ByteBloomFilter Implements a Bloom filter, as defined by Bloom in 1970.
ByteBufferArray This class manages an array of ByteBuffers with a default size 4MB.
ByteBufferUtils Utility functions for working with byte buffers, such as reading/writing variable-length long numbers.
ByteRangeUtils Utility methods for working with ByteRange.
Bytes Utility class that handles byte arrays, conversions to/from other types, comparisons, hash code generation, manufacturing keys for HashMaps or HashSets, etc.
Bytes.ByteArrayComparator Byte array comparator class.
Bytes.RowEndKeyComparator A Bytes.ByteArrayComparator that treats the empty array as the largest value.
ByteStringer Hack to workaround HBASE-1304 issue that keeps bubbling up when a mapreduce context.
ChecksumFactory Utility class that is used to generate a Checksum object.
Classes Utilities for class manipulation.
ClassLoaderBase Base class loader that defines couple shared constants used by sub-classes.
ClassSize Class for determining the "size" of a class, an attempt to calculate the actual bytes that an object of this class will occupy in memory The core of this class is taken from the Derby project
CollectionBackedScanner Utility scanner that wraps a sortable collection and serves as a KeyValueScanner.
CollectionUtils Utility methods for dealing with Collections, including treating null collections as empty.
CompoundBloomFilter A Bloom filter implementation built on top of ByteBloomFilter, encapsulating a set of fixed-size Bloom filters written out at the time of HFile generation into the data block stream, and loaded on demand at query time.
CompoundBloomFilterBase  
CompoundBloomFilterWriter Adds methods required for writing a compound Bloom filter to the data section of an HFile to the CompoundBloomFilter class.
CompressionTest Compression validation test.
ConcatenatedLists<T> A collection class that contains multiple sub-lists, which allows us to not copy lists.
ConcurrentIndex<K,V> A simple concurrent map of sets.
ConfigurationUtil Utilities for storing more complex collection types in Configuration instances.
ConfigUtil Some configuration related utilities
ConnectionCache A utility to store user specific HConnections in memory.
CoprocessorClassLoader ClassLoader used to load classes for Coprocessor instances.
DefaultEnvironmentEdge Default implementation of an environment edge.
DirectMemoryUtils Utilities for interacting with and monitoring DirectByteBuffer allocations.
DNS Wrapper around Hadoop's DNS class to hide reflection.
DrainBarrier A simple barrier that can be used by classes that need to wait for some operations to finish before stopping/closing/etc.
DynamicClassLoader This is a class loader that can load classes dynamically from new jar files under a configured folder.
EncryptionTest  
EnvironmentEdgeManager Manages a singleton instance of the environment edge.
ExceptionUtil This class handles the different interruption classes.
FSHDFSUtils Implementation for hdfs
FSMapRUtils MapR implementation.
FSTableDescriptorMigrationToSubdir Deprecated. will be removed for the major release after 0.96.
FSTableDescriptors Implementation of TableDescriptors that reads descriptors from the passed filesystem.
FSUtils Utility methods for interacting with the underlying file system.
FSUtils.BlackListDirFilter Directory filter that doesn't include any of the directories in the specified blacklist
FSUtils.DirFilter A PathFilter that only allows directories.
FSUtils.FamilyDirFilter Filter for all dirs that are legal column family names.
FSUtils.HFileFilter Filter for HFiles that excludes reference files.
FSUtils.ReferenceFileFilter  
FSUtils.RegionDirFilter Filter for all dirs that don't start with '.'
FSUtils.UserTableDirFilter A PathFilter that returns usertable directories.
FSVisitor Utility methods for interacting with the hbase.root file system.
GetJavaProperty A generic way for querying Java properties.
Hash This class represents a common API for hashing functions.
HashedBytes This class encapsulates a byte array and overrides hashCode and equals so that it's identity is based on the data rather than the array instance.
HasThread Abstract class which contains a Thread and delegates the common Thread methods to that instance.
HBaseConfTool Tool that prints out a configuration.
HBaseFsck HBaseFsck (hbck) is a tool for checking and repairing region consistency and table integrity problems in a corrupted HBase.
HBaseFsck.HbckInfo Maintain information about a particular region.
HBaseFsckRepair This class contains helper methods that repair parts of hbase's filesystem contents.
HFileArchiveUtil Helper class for all utilities related to archival/retrieval of HFiles
HFileV1Detector Tool to detect presence of any HFileV1 in the given directory.
HttpServerUtil HttpServer utility.
IdLock Allows multiple concurrent clients to lock on a numeric id with a minimal memory overhead.
IdLock.Entry An entry returned to the client as a lock object
IncrementingEnvironmentEdge Uses an incrementing algorithm instead of the default.
InfoServer Create a Jetty embedded server to answer http requests.
IterableUtils Utility methods for Iterable including null-safe handlers.
JenkinsHash Produces 32-bit hash for hash table lookup.
JsonMapper Utility class for converting objects to JSON
JVM This class is a wrapper for the implementation of com.sun.management.UnixOperatingSystemMXBean It will decide to use the sun api or its own implementation depending on the runtime (vendor) used.
JVMClusterUtil Utility used running a cluster all in the one JVM.
JVMClusterUtil.MasterThread Datastructure to hold Master Thread and Master instance
JVMClusterUtil.RegionServerThread Datastructure to hold RegionServer Thread and RegionServer instance
JvmPauseMonitor Class which sets up a simple thread which runs in a loop sleeping for a short interval of time.
JvmVersion Certain JVM versions are known to be unstable with HBase.
KeyLocker<K extends Comparable<? super K>> A utility class to manage a set of locks.
ManualEnvironmentEdge An environment edge that uses a manually set value.
MapreduceDependencyClasspathTool Generate a classpath string containing any jars required by mapreduce jobs.
MD5Hash Utility class for MD5 MD5 hash produces a 128-bit digest.
Merge Utility that can merge any two regions in the same table: adjacent, overlapping or disjoint.
MetaUtils Contains utility methods for manipulating HBase meta tables.
Methods  
ModifyRegionUtils Utility methods for interacting with the regions.
MultiHConnection Provides ability to create multiple HConnection instances and allows to process a batch of actions using HConnection.processBatchCallback()
MunkresAssignment Computes the optimal (minimal cost) assignment of jobs to workers (or other analogous) concepts given a cost matrix of each pair of job and worker, using the algorithm by James Munkres in "Algorithms for the Assignment and Transportation Problems", with additional optimizations as described by Jin Kue Wong in "A New Implementation of an Algorithm for the Optimal Assignment Problem: An Improved Version of Munkres' Algorithm".
MurmurHash This is a very fast, non-cryptographic hash suitable for general hash-based lookup.
MurmurHash3 This is a very fast, non-cryptographic hash suitable for general hash-based lookup.
OrderedBytes Utility class that handles ordered byte arrays.
Pair<T1,T2> A generic class for pairs.
PairOfSameType<T> A generic, immutable class for pairs of objects both of type T.
PoolMap<K,V> The PoolMap maps a key to a collection of values, the elements of which are managed by a pool.
PrettyPrinter  
ProtoUtil  
ReflectionUtils  
RegionSizeCalculator Computes size of each region for given table and given column families.
RegionSplitCalculator<R extends KeyRange> This is a generic region split calculator.
RegionSplitter The RegionSplitter class provides several utilities to help in the administration lifecycle for developers who choose to manually split regions instead of having HBase handle that automatically.
RegionSplitter.HexStringSplit HexStringSplit is a well-known RegionSplitter.SplitAlgorithm for choosing region boundaries.
RegionSplitter.UniformSplit A SplitAlgorithm that divides the space of possible keys evenly.
RetryCounter  
RetryCounter.BackoffPolicy Policy for calculating sleeping intervals between retry attempts
RetryCounter.ExponentialBackoffPolicy  
RetryCounter.ExponentialBackoffPolicyWithLimit  
RetryCounter.RetryConfig Configuration for a retry counter
RetryCounterFactory  
ServerCommandLine Base class for command lines that start up various HBase daemons.
ShutdownHookManager This class provides ShutdownHookManager shims for HBase to interact with the Hadoop 1.0.x and the Hadoop 2.0+ series.
SimpleByteRange A basic ByteRange implementation.
SimplePositionedByteRange Extends the basic SimpleByteRange implementation with position support.
Sleeper Sleeper for current thread.
SortedCopyOnWriteSet<E> Simple SortedSet implementation that uses an internal TreeSet to provide ordering.
SortedList<E> Simple sorted list implementation that uses ArrayList as the underlying collection so we can support RandomAccess.
Strings Utility for Strings.
Threads Thread Utility
Triple<A,B,C> Utility class to manage a triple.
UnsafeAccess  
VersionInfo This class finds the package info for hbase and the VersionAnnotation information.
Writables Utility class with methods for manipulating Writable objects
ZKDataMigrator Tool to migrate zookeeper data of older hbase versions(<0.95.0) to PB.
 

Enum Summary
ChecksumType Checksum types.
HBaseFsck.ErrorReporter.ERROR_CODE  
Order Used to describe or modify the lexicographical sort order of a byte[].
PoolMap.PoolType  
PrettyPrinter.Unit  
 

Exception Summary
FileSystemVersionException Thrown when the file system needs to be upgraded
HBaseFsck.RegionRepairException Exception thrown when a integrity repair operation fails in an unresolvable way.
 



Copyright © 2007–2015 The Apache Software Foundation. All rights reserved.