View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  
19  package org.apache.hadoop.hbase.codec.prefixtree.encode;
20  
21  import java.io.OutputStream;
22  
23  import org.apache.hadoop.classification.InterfaceAudience;
24  
25  /**
26   * Retrieve PrefixTreeEncoders from this factory which handles pooling them and preparing the
27   * ones retrieved from the pool for usage.
28   */
29  @InterfaceAudience.Private
30  public class EncoderFactory {
31  
32    private static final EncoderPool POOL = new EncoderPoolImpl();
33  
34  
35    public static PrefixTreeEncoder checkOut(OutputStream outputStream, boolean includeMvccVersion) {
36      return POOL.checkOut(outputStream, includeMvccVersion);
37    }
38  
39    public static void checkIn(PrefixTreeEncoder encoder) {
40      POOL.checkIn(encoder);
41    }
42  
43  
44    /**************************** helper ******************************/
45  
46    protected static PrefixTreeEncoder prepareEncoder(PrefixTreeEncoder encoder,
47        OutputStream outputStream, boolean includeMvccVersion) {
48      PrefixTreeEncoder ret = encoder;
49      if (encoder == null) {
50        ret = new PrefixTreeEncoder(outputStream, includeMvccVersion);
51      }
52      ret.reset(outputStream, includeMvccVersion);
53      return ret;
54    }
55  
56  }