Class SubstringComparator

src/SubstringComparator.java:42–97

A substring comparator used in comparison filters such as RowFilter, QualifierFilter, and ValueFilter. A Substring comparator matches any value which contains the provided substring. Only EQUAL and NOT_EQUAL comparisons are valid with this comparator. @since 1.6

 * @since 1.6
 */
public final class SubstringComparator extends FilterComparator {

  private static final byte[] NAME =
      Bytes.UTF8("org.apache.hadoop.hbase.filter.SubstringComparator");

  private final String substr;

  public SubstringComparator(String substr) {
    this.substr = substr;
  }

  public String substring() {
    return this.substr;
  }

  @Override
  byte[] name() {
    return NAME;
  }

  @Override
  ComparatorPB.Comparator toProtobuf() {
    ByteString byte_string = ComparatorPB
        .SubstringComparator
        .newBuilder()
        .setSubstr(substr)
        .build()
        .toByteString();
    return super.toProtobuf(byte_string);
  }

  @Override
  void serializeOld(ChannelBuffer buf) {
    super.serializeOld(buf);                 // super.predictSerializedSize()
    // Write code
    buf.writeByte(0);                        // 1
    buf.writeByte((byte) NAME.length);       // 1
    buf.writeBytes(NAME);                    // NAME.length
    // writeUTF the substring
    byte[] expr_bytes = Bytes.UTF8(substr);
    buf.writeShort(expr_bytes.length);       // 2
    buf.writeBytes(expr_bytes);              // expr.length
  }

  @Override
  int predictSerializedSize() {
    return super.predictSerializedSize()
        + 1 + 1 + NAME.length
        + 2 + Bytes.UTF8(substr).length;
  }

  @Override
  public String toString() {
    return String.format("%s(%s)", getClass().getSimpleName(), substr);
  }
}