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 package com.google.protobuf; 32 33 import java.util.Map; 34 35 interface MapFieldSchema { 36 /** Returns the map data for mutation. */ forMutableMapData(Object mapField)37 Map<?, ?> forMutableMapData(Object mapField); 38 39 /** Returns the map data for read. */ forMapData(Object mapField)40 Map<?, ?> forMapData(Object mapField); 41 42 /** Whether toImmutable() has been called on this map field. */ isImmutable(Object mapField)43 boolean isImmutable(Object mapField); 44 45 /** 46 * Returns an immutable instance of the map field. It may make the parameter immutable and return 47 * the parameter, or create an immutable copy. The status of the parameter after the call is 48 * undefined. 49 */ toImmutable(Object mapField)50 Object toImmutable(Object mapField); 51 52 /** Returns a new instance of the map field given a map default entry. */ newMapField(Object mapDefaultEntry)53 Object newMapField(Object mapDefaultEntry); 54 55 /** Returns the metadata from a default entry. */ forMapMetadata(Object mapDefaultEntry)56 MapEntryLite.Metadata<?, ?> forMapMetadata(Object mapDefaultEntry); 57 58 /** Merges {@code srcMapField} into {@code destMapField}, and returns the merged instance. */ mergeFrom(Object destMapField, Object srcMapField)59 Object mergeFrom(Object destMapField, Object srcMapField); 60 61 /** Compute the serialized size for the map with a given field number. */ getSerializedSize(int fieldNumber, Object mapField, Object mapDefaultEntry)62 int getSerializedSize(int fieldNumber, Object mapField, Object mapDefaultEntry); 63 } 64