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)}. 026 * Includes a termination marker following the 027 * raw {@code byte[]} value. Intended to make it easier to transition 028 * away from direct use of {@link org.apache.hadoop.hbase.util.Bytes}. 029 * @see org.apache.hadoop.hbase.util.Bytes#toBytes(String) 030 * @see org.apache.hadoop.hbase.util.Bytes#toString(byte[], int, int) 031 * @see RawString 032 * @see OrderedString 033 */ 034@InterfaceAudience.Public 035public class RawStringTerminated extends TerminatedWrapper<String> { 036 037 /** 038 * Create a {@code RawStringTerminated} using the specified terminator and 039 * {@code order}. 040 * @throws IllegalArgumentException if {@code term} is {@code null} or empty. 041 */ 042 public RawStringTerminated(Order order, byte[] term) { 043 super(new RawString(order), term); 044 } 045 046 /** 047 * Create a {@code RawStringTerminated} using the specified terminator and 048 * {@code order}. 049 * @throws IllegalArgumentException if {@code term} is {@code null} or empty. 050 */ 051 public RawStringTerminated(Order order, String term) { 052 super(new RawString(order), term); 053 } 054 055 /** 056 * Create a {@code RawStringTerminated} using the specified terminator. 057 * @throws IllegalArgumentException if {@code term} is {@code null} or empty. 058 */ 059 public RawStringTerminated(byte[] term) { 060 super(new RawString(), term); 061 } 062 063 /** 064 * Create a {@code RawStringTerminated} using the specified terminator. 065 * @throws IllegalArgumentException if {@code term} is {@code null} or empty. 066 */ 067 public RawStringTerminated(String term) { 068 super(new RawString(), term); 069 } 070}