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 */
018
019package org.apache.hadoop.hbase;
020
021import org.apache.yetus.audience.InterfaceAudience;
022
023/**
024 * Create a CellBuilder instance. Currently, we have two kinds of Cell Builder.
025 * {@link CellBuilderType#DEEP_COPY} All bytes array passed into builder will be copied to build an new Cell.
026 *                                   The cell impl is {@link org.apache.hadoop.hbase.KeyValue}
027 * {@link CellBuilderType#SHALLOW_COPY} Just copy the references of passed bytes array to build an new Cell
028 *                                      The cell impl is {@link org.apache.hadoop.hbase.IndividualBytesFieldCell}
029 * NOTE: The cell impl may be changed in the future. The user application SHOULD NOT depend on any concrete cell impl.
030 */
031@InterfaceAudience.Public
032public final class CellBuilderFactory {
033
034  /**
035   * Create a CellBuilder instance.
036   * @param type indicates which memory copy is used in building cell.
037   * @return An new CellBuilder
038   */
039  public static CellBuilder create(CellBuilderType type) {
040    switch (type) {
041      case SHALLOW_COPY:
042        return new IndividualBytesFieldCellBuilder();
043      case DEEP_COPY:
044        return new KeyValueBuilder();
045      default:
046        throw new UnsupportedOperationException("The type:" + type + " is unsupported");
047    }
048  }
049
050  private CellBuilderFactory(){
051  }
052}