1  2// Protocol Buffers - Google's data interchange format  3// Copyright 2023 Google Inc.  All rights reserved.  4//  5// Use of this source code is governed by a BSD-style  6// license that can be found in the LICENSE file or at  7// https://developers.google.com/open-source/licenses/bsd  8  9syntax = "proto2"; 10 11package pb; 12 13import "google/protobuf/descriptor.proto"; 14 15option java_package = "com.google.protobuf"; 16option java_outer_classname = "JavaFeaturesProto"; 17 18extend google.protobuf.FeatureSet { 19  optional JavaFeatures java = 1001; 20} 21 22message JavaFeatures { 23  // Whether or not to treat an enum field as closed.  This option is only 24  // applicable to enum fields, and will be removed in the future.  It is 25  // consistent with the legacy behavior of using proto3 enum types for proto2 26  // fields. 27  optional bool legacy_closed_enum = 1 [ 28    retention = RETENTION_RUNTIME, 29    targets = TARGET_TYPE_FIELD, 30    targets = TARGET_TYPE_FILE, 31    feature_support = { 32      edition_introduced: EDITION_2023, 33      edition_deprecated: EDITION_2023, 34      deprecation_warning: "The legacy closed enum behavior in Java is " 35                           "deprecated and is scheduled to be removed in " 36                           "edition 2025.  See http://protobuf.dev/programming-guides/enum/#java for " 37                           "more information.", 38    }, 39    edition_defaults = { edition: EDITION_LEGACY, value: "true" }, 40    edition_defaults = { edition: EDITION_PROTO3, value: "false" } 41  ]; 42 43  // The UTF8 validation strategy to use. 44  enum Utf8Validation { 45    // Invalid default, which should never be used. 46    UTF8_VALIDATION_UNKNOWN = 0; 47    // Respect the UTF8 validation behavior specified by the global 48    // utf8_validation feature. 49    DEFAULT = 1; 50    // Verifies UTF8 validity overriding the global utf8_validation 51    // feature. This represents the legacy java_string_check_utf8 option. 52    VERIFY = 2; 53  } 54  optional Utf8Validation utf8_validation = 2 [ 55    retention = RETENTION_RUNTIME, 56    targets = TARGET_TYPE_FIELD, 57    targets = TARGET_TYPE_FILE, 58    feature_support = { 59      edition_introduced: EDITION_2023, 60      edition_deprecated: EDITION_2024, 61      deprecation_warning: "The Java-specific utf8 validation feature is " 62                           "deprecated and is scheduled to be removed in " 63                           "edition 2025.  Utf8 validation behavior should " 64                           "use the global cross-language utf8_validation " 65                           "feature.", 66    }, 67    edition_defaults = { edition: EDITION_LEGACY, value: "DEFAULT" } 68  ]; 69 70  // Allows creation of large Java enums, extending beyond the standard 71  // constant limits imposed by the Java language. 72  optional bool large_enum = 3 [ 73    retention = RETENTION_RUNTIME, 74    targets = TARGET_TYPE_ENUM, 75    targets = TARGET_TYPE_FILE, 76    feature_support = { 77      edition_introduced: EDITION_2024, 78    }, 79    edition_defaults = { edition: EDITION_LEGACY, value: "false" } 80  ]; 81 82  // Whether to use the old default outer class name scheme, or the new feature 83  // which adds a "Proto" suffix to the outer class name. 84  // 85  // Users will not be able to set this option, because we removed it in the 86  // same edition that it was introduced. But we use it to determine which 87  // naming scheme to use for outer class name defaults. 88  optional bool use_old_outer_classname_default = 4 [ 89    retention = RETENTION_RUNTIME, 90    targets = TARGET_TYPE_FILE, 91    feature_support = { 92      edition_introduced: EDITION_2024, 93      edition_removed: EDITION_2024, 94    }, 95    edition_defaults = { edition: EDITION_LEGACY, value: "true" }, 96    edition_defaults = { edition: EDITION_2024, value: "false" } 97  ]; 98 99  message NestInFileClassFeature {100    enum NestInFileClass {101      // Invalid default, which should never be used.102      NEST_IN_FILE_CLASS_UNKNOWN = 0;103      // Do not nest the generated class in the file class.104      NO = 1;105      // Nest the generated class in the file class.106      YES = 2;107      // Fall back to the `java_multiple_files` option. Users won't be able to108      // set this option.109      LEGACY = 3 [feature_support = {110        edition_introduced: EDITION_2024111        edition_removed: EDITION_2024112      }];113    }114    reserved 1 to max;115  }116117  // Whether to nest the generated class in the generated file class. This is118  // only applicable to *top-level* messages, enums, and services.119  optional NestInFileClassFeature.NestInFileClass nest_in_file_class = 5 [120    retention = RETENTION_SOURCE,121    targets = TARGET_TYPE_MESSAGE,122    targets = TARGET_TYPE_ENUM,123    targets = TARGET_TYPE_SERVICE,124    feature_support = {125      edition_introduced: EDITION_2024,126    },127    edition_defaults = { edition: EDITION_LEGACY, value: "LEGACY" },128    edition_defaults = { edition: EDITION_2024, value: "NO" }129  ];130}