aboutsummaryrefslogtreecommitdiff
path: root/java/core/src/main/java/com/google/protobuf/Proto3SchemaFactory.java
blob: c991dd129d9d768ad51dcd49038c8fe0d70d8298 (plain) (blame)
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
// Protocol Buffers - Google's data interchange format
// Copyright 2008 Google Inc.  All rights reserved.
// https://developers.google.com/protocol-buffers/
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package com.google.protobuf;

import static com.google.protobuf.Internal.checkNotNull;

/**
 * Manufactures schemas for proto3 messages. Message classes must extend {@link
 * com.google.protobuf.GeneratedMessage} or {@link com.google.protobuf.GeneratedMessageLite}.
 */
@ExperimentalApi
public final class Proto3SchemaFactory implements SchemaFactory {
  /**
   * The mode with which to generate schemas.
   *
   * <p>For testing purposes only.
   */
  public enum Mode {
    /** Always use a table-based indexing of fields. */
    TABLE,

    /** Always used lookup-based (i.e. binary search) indexing of fields. */
    LOOKUP,

    /**
     * Default. Determine the appropriate field indexing mode based on how sparse the field numbers
     * are for the message.
     */
    DYNAMIC
  }

  private final MessageInfoFactory messageDescriptorFactory;
  private final Mode mode;

  public Proto3SchemaFactory() {
    this(DescriptorMessageInfoFactory.getInstance());
  }

  public Proto3SchemaFactory(MessageInfoFactory messageDescriptorFactory) {
    this(messageDescriptorFactory, Mode.DYNAMIC);
  }

  /** For testing purposes only. Allows specification of {@link Mode}. */
  public Proto3SchemaFactory(MessageInfoFactory messageDescriptorFactory, Mode mode) {
    if (!isSupported()) {
      throw new IllegalStateException("Schema factory is unsupported on this platform");
    }
    this.messageDescriptorFactory =
        checkNotNull(messageDescriptorFactory, "messageDescriptorFactory");
    this.mode = checkNotNull(mode, "mode");
  }

  public static boolean isSupported() {
    return UnsafeUtil.hasUnsafeArrayOperations() && UnsafeUtil.hasUnsafeByteBufferOperations();
  }

  @Override
  public <T> Schema<T> createSchema(Class<T> messageType) {
    SchemaUtil.requireGeneratedMessage(messageType);

    MessageInfo descriptor = messageDescriptorFactory.messageInfoFor(messageType);
    switch (mode) {
      case TABLE:
        return newTableSchema(messageType, descriptor);
      case LOOKUP:
        return newLookupSchema(messageType, descriptor);
      default:
        return SchemaUtil.shouldUseTableSwitch(descriptor.getFields())
            ? newTableSchema(messageType, descriptor)
            : newLookupSchema(messageType, descriptor);
    }
  }

  private <T> Schema<T> newTableSchema(Class<T> messageType, MessageInfo descriptor) {
    if (GeneratedMessageLite.class.isAssignableFrom(messageType)) {
      return new Proto3LiteTableSchema<T>(messageType, descriptor);
    }
    return new Proto3TableSchema<T>(messageType, descriptor);
  }

  private <T> Schema<T> newLookupSchema(Class<T> messageType, MessageInfo descriptor) {
    if (GeneratedMessageLite.class.isAssignableFrom(messageType)) {
      return new Proto3LiteLookupSchema<T>(messageType, descriptor);
    }
    return new Proto3LookupSchema<T>(messageType, descriptor);
  }
}