aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/lib/skyframe/serialization/strings/StringCodecs.java
blob: 60e5f29f87efc368ca0e105a93bddbc84165033b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
// Copyright 2017 The Bazel Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//    http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package com.google.devtools.build.lib.skyframe.serialization.strings;

import com.google.devtools.build.lib.skyframe.serialization.ObjectCodec;
import java.util.logging.Logger;

/** Utility for accessing (potentially platform-specific) {@link String} {@link ObjectCodec}s. */
public final class StringCodecs {

  private static final Logger logger = Logger.getLogger(StringCodecs.class.getName());

  private static final StringCodec stringCodec;
  private static final ObjectCodec<String> asciiOptimized;

  static {
    stringCodec = new StringCodec();
    if (FastStringCodec.isAvailable()) {
      asciiOptimized = new FastStringCodec();
    } else {
      logger.warning("Optimized string deserialization unavailable");
      asciiOptimized = stringCodec;
    }
  }

  private StringCodecs() {}

  /**
   * Returns whether or not optimized codecs are available. Exposed so users can check at runtime
   * if the expected optimizations are applied.
   */
  public static boolean supportsOptimizedAscii() {
    return asciiOptimized instanceof FastStringCodec;
  }

  /**
   * Returns singleton instance optimized for almost-always ASCII data, if supported. Otherwise,
   * returns a functional, but not optimized implementation. To tell if the optimized version is
   * supported see {@link #supportsOptimizedAscii()}.
   *
   * <p>Note that when optimized, this instance can still serialize/deserialize UTF-8 data, but with
   *  potentially worse performance than {@link #simple()}.
   */
  public static ObjectCodec<String> asciiOptimized() {
    return asciiOptimized;
  }

  /**
   * Returns singleton instance of basic implementation. Should be preferred over
   * {@link #asciiOptimized()} when a sufficient amount of UTF-8 data is expected.
   */
  public static ObjectCodec<String> simple() {
    return stringCodec;
  }
}