001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.types;
019
020import org.apache.hadoop.hbase.util.Order;
021import org.apache.yetus.audience.InterfaceAudience;
022
023/**
024 * An {@code DataType} that encodes variable-length values encoded using
025 * {@link org.apache.hadoop.hbase.util.Bytes#toBytes(String)}. Includes a termination marker
026 * following the raw {@code byte[]} value. Intended to make it easier to transition away from direct
027 * use of {@link org.apache.hadoop.hbase.util.Bytes}.
028 * @see org.apache.hadoop.hbase.util.Bytes#toBytes(String)
029 * @see org.apache.hadoop.hbase.util.Bytes#toString(byte[], int, int)
030 * @see RawString
031 * @see OrderedString
032 */
033@InterfaceAudience.Public
034public class RawStringTerminated extends TerminatedWrapper<String> {
035
036  /**
037   * Create a {@code RawStringTerminated} using the specified terminator and {@code order}.
038   * @throws IllegalArgumentException if {@code term} is {@code null} or empty.
039   */
040  public RawStringTerminated(Order order, byte[] term) {
041    super(new RawString(order), term);
042  }
043
044  /**
045   * Create a {@code RawStringTerminated} using the specified terminator and {@code order}.
046   * @throws IllegalArgumentException if {@code term} is {@code null} or empty.
047   */
048  public RawStringTerminated(Order order, String term) {
049    super(new RawString(order), term);
050  }
051
052  /**
053   * Create a {@code RawStringTerminated} using the specified terminator.
054   * @throws IllegalArgumentException if {@code term} is {@code null} or empty.
055   */
056  public RawStringTerminated(byte[] term) {
057    super(new RawString(Order.ASCENDING), term);
058  }
059
060  /**
061   * Create a {@code RawStringTerminated} using the specified terminator.
062   * @throws IllegalArgumentException if {@code term} is {@code null} or empty.
063   */
064  public RawStringTerminated(String term) {
065    super(new RawString(Order.ASCENDING), term);
066  }
067}