java/core/src/test/proto/com/google/protobuf/map_for_proto2_test.proto

   1 // Protocol Buffers - Google's data interchange format
   2 // Copyright 2008 Google Inc.  All rights reserved.
   3 // https://developers.google.com/protocol-buffers/
   4 //
   5 // Redistribution and use in source and binary forms, with or without
   6 // modification, are permitted provided that the following conditions are
   7 // met:
   8 //
   9 //     * Redistributions of source code must retain the above copyright
  10 // notice, this list of conditions and the following disclaimer.
  11 //     * Redistributions in binary form must reproduce the above
  12 // copyright notice, this list of conditions and the following disclaimer
  13 // in the documentation and/or other materials provided with the
  14 // distribution.
  15 //     * Neither the name of Google Inc. nor the names of its
  16 // contributors may be used to endorse or promote products derived from
  17 // this software without specific prior written permission.
  18 //
  19 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30
  31 syntax = "proto2";
  32
  33 package map_for_proto2_test;
  34
  35 option java_package = "map_test";
  36 option java_outer_classname = "MapForProto2TestProto";
  37
  38 message TestMap {
  39   message MessageValue {
  40     optional int32 value = 1;
  41   }
  42   enum EnumValue {
  43     FOO = 0;
  44     BAR = 1;
  45     BAZ = 2;
  46     QUX = 3;
  47   }
  48
  49   map<int32, int32> int32_to_int32_field = 1;
  50   map<int32, string> int32_to_string_field = 2;
  51   map<int32, bytes> int32_to_bytes_field = 3;
  52   map<int32, EnumValue> int32_to_enum_field = 4;
  53   map<int32, MessageValue> int32_to_message_field = 5;
  54   map<string, int32> string_to_int32_field = 6;
  55
  56   message MessageWithRequiredFields {
  57     required int32 value = 1;
  58   }
  59   map<int32, MessageWithRequiredFields> required_message_map = 11;
  60 }
  61
  62 message TestUnknownEnumValue {
  63   // Wire-compatible with TestMap.int32_to_enum_field so we can test the
  64   // parsing behavior of TestMap regarding unknown enum values.
  65   map<int32, int32> int32_to_int32_field = 4;
  66 }
  67
  68 // Test that the maps initialization code works correctly when the map field
  69 // references the containing message.
  70 message TestRecursiveMap {
  71   optional int32 value = 1;
  72   map<int32, TestRecursiveMap> recursive_map_field = 2;
  73 }
  74
  75 // a decoy of TestMap for testing parsing errors
  76 message BizarroTestMap {
  77   // same key type, different value
  78   map<int32, bytes> int32_to_int32_field = 1;
  79   // different key and value types
  80   map<string, int32> int32_to_string_field = 2;
  81   // different key types, same value
  82   map<string, int32> int32_to_bytes_field = 3;
  83   // different key and value types
  84   map<string, bytes> int32_to_enum_field = 4;
  85   // different key and value types
  86   map<string, bytes> int32_to_message_field = 5;
  87   // same key type, different value
  88   map<string, bytes> string_to_int32_field = 6;
  89 }
  90
  91 // Used to test that java reserved words can be used as protobuf field names
  92 // Not all reserved words are tested (to avoid bloat) but instead an arbitrary
  93 // subset of them chosen to cover various keyword categories like
  94 // type, modifier, declaration, etc.
  95 message ReservedAsMapField {
  96   map<string, uint32> if = 1;
  97   map<string, uint32> const = 2;
  98   map<string, uint32> private = 3;
  99   map<string, uint32> class = 4;
 100   map<string, uint32> int = 5;
 101   map<string, uint32> void = 6;
 102   // These are also proto keywords
 103   map<string, uint32> string = 7;
 104   map<string, uint32> package = 8;
 105   // Most recent Java reserved word
 106   map<string, uint32> enum = 9;
 107   // null is not a 'reserved word' per se but as a literal needs similar care
 108   map<string, uint32> null = 10;
 109 }
 110
 111 message ReservedAsMapFieldWithEnumValue {
 112   enum SampleEnum {
 113     A = 0;
 114     B = 1;
 115   }
 116   map<string, SampleEnum> if = 1;
 117   map<string, SampleEnum> const = 2;
 118   map<string, SampleEnum> private = 3;
 119   map<string, SampleEnum> class = 4;
 120   map<string, SampleEnum> int = 5;
 121   map<string, SampleEnum> void = 6;
 122   // These are also proto keywords
 123   map<string, SampleEnum> string = 7;
 124   map<string, SampleEnum> package = 8;
 125   // Most recent Java reserved word
 126   map<string, SampleEnum> enum = 9;
 127   // null is not a 'reserved word' per se but as a literal needs similar care
 128   map<string, SampleEnum> null = 10;
 129 }