/*
 * Copyright (C) 2013  The Async HBase Authors.  All rights reserved.
 * This file is part of Async HBase.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *   - Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *   - Redistributions in binary form must reproduce the above copyright notice,
 *     this list of conditions and the following disclaimer in the documentation
 *     and/or other materials provided with the distribution.
 *   - Neither the name of the StumbleUpon nor the names of its contributors
 *     may be used to endorse or promote products derived from this software
 *     without specific prior written permission.
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package org.hbase.async;

import org.jboss.netty.buffer.ChannelBuffer;

/**
 * @since 1.5
 */
public abstract class ScanFilter {

  /**
   * Serializes the byte representation to the RPC channel buffer.
   * @param buf The RPC channel buffer to which the byte array is serialized
   * @since 1.5
   */
  abstract void serialize(ChannelBuffer buf);

  /**
   * returns the number of bytes that it will write to the RPC channel buffer when {@code serialize}
   * is called. This method helps predict the initial size of the byte array
   * @return A strictly positive integer
   * @since 1.5
   */
  abstract int predictSerializedSize();

}

@@ -1699,57 +1699,789 @@
 %0A * 
-@since 1.5%0A */%0Apublic abstract class ScanFilter %7B
+Abstract base class for %7B@link org.hbase.async.Scanner%7D filters.%0A * %3Cp%3E%0A * These filters are executed on the server side, inside the%0A * %7B@code RegionServer%7D, while scanning.  They are useful to%0A * prune uninteresting data before it gets to the network,%0A * but remember that the %7B@code RegionServer%7D still has to%0A * load the data before it can know whether the filter passes%0A * or not, so it's generally not efficient to filter out large%0A * amounts of data.%0A * %3Cp%3E%0A * Subclasses are guaranteed to be immutable and are thus%0A * thread-safe as well as usable concurrently on multiple%0A * %7B@link org.hbase.async.Scanner%7D instances.%0A * @since 1.5%0A */%0Apublic abstract class ScanFilter %7B%0A%0A  /** Package-private constructor to avoid sub-classing outside this package. */%0A  ScanFilter() %7B%0A  %7D
 %0A%0A  

Document ScanFilter and prevent it from being subclassed externally.