Package com.google.protobuf

Class MapEntry<K,​V>

  • All Implemented Interfaces:
    Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder
    public final class MapEntry<K,​V>
extends AbstractMessage
    Implements MapEntry messages.

    In reflection API, map fields will be treated as repeated message fields and each map entry is accessed as a message. This MapEntry class is used to represent these map entry messages in reflection API.

    Protobuf internal. Users shouldn't use this class.

    • Method Detail

      • newDefaultInstance

        public static <K,​V> MapEntry<K,​V> newDefaultInstance​(Descriptors.Descriptor descriptor,
                                                                 WireFormat.FieldType keyType,
                                                                 K defaultKey,
                                                                 WireFormat.FieldType valueType,
                                                                 V defaultValue)
        Create a default MapEntry instance. A default MapEntry instance should be created only once for each map entry message type. Generated code should store the created default instance and use it later to create new MapEntry messages of the same type.

      • getKey

        public K getKey()

      • getValue

        public V getValue()

      • writeTo

        public void writeTo​(CodedOutputStream output)
             throws java.io.IOException
        Description copied from interface: MessageLite
        Serializes the message and writes it to output. This does not flush or close the stream.
        Specified by:
        writeTo in interface MessageLite
        Overrides:
        writeTo in class AbstractMessage
        Throws:
        java.io.IOException

      • getParserForType

        public Parser<MapEntry<K,​V>> getParserForType()
        Description copied from interface: MessageLite
        Gets the parser for a message of the same type as this message.

      • newBuilderForType

        public MapEntry.Builder<K,​V> newBuilderForType()
        Description copied from interface: MessageLite
        Constructs a new builder for a message of the same type as this message.

      • toBuilder

        public MapEntry.Builder<K,​V> toBuilder()
        Description copied from interface: MessageLite
        Constructs a builder initialized with the current message. Use this to derive a new message from the current one.

      • getDefaultInstanceForType

        public MapEntry<K,​V> getDefaultInstanceForType()
        Description copied from interface: MessageLiteOrBuilder
        Get an instance of the type with no fields set. Because no fields are set, all getters for singular fields will return default values and repeated fields will appear empty. This may or may not be a singleton. This differs from the getDefaultInstance() method of generated message classes in that this method is an abstract method of the MessageLite interface whereas getDefaultInstance() is a static method of a specific class. They return the same thing.

      • getDescriptorForType

        public Descriptors.Descriptor getDescriptorForType()
        Description copied from interface: MessageOrBuilder
        Get the message's type's descriptor. This differs from the getDescriptor() method of generated message classes in that this method is an abstract method of the Message interface whereas getDescriptor() is a static method of a specific class. They return the same thing.

      • getAllFields

        public java.util.Map<Descriptors.FieldDescriptor,​java.lang.Object> getAllFields()
        Description copied from interface: MessageOrBuilder
        Returns a collection of all the fields in this message which are set and their corresponding values. A singular ("required" or "optional") field is set iff hasField() returns true for that field. A "repeated" field is set iff getRepeatedFieldCount() is greater than zero. The values are exactly what would be returned by calling MessageOrBuilder.getField(Descriptors.FieldDescriptor) for each field. The map is guaranteed to be a sorted map, so iterating over it will return fields in order by field number.
        If this is for a builder, the returned map may or may not reflect future changes to the builder. Either way, the returned map is itself unmodifiable.

      • hasField

        public boolean hasField​(Descriptors.FieldDescriptor field)
        Description copied from interface: MessageOrBuilder
        Returns true if the given field is set. This is exactly equivalent to calling the generated "has" accessor method corresponding to the field.

      • getField

        public java.lang.Object getField​(Descriptors.FieldDescriptor field)
        Description copied from interface: MessageOrBuilder
        Obtains the value of the given field, or the default value if it is not set. For primitive fields, the boxed primitive value is returned. For enum fields, the EnumValueDescriptor for the value is returned. For embedded message fields, the sub-message is returned. For repeated fields, a java.util.List is returned.

      • getRepeatedFieldCount

        public int getRepeatedFieldCount​(Descriptors.FieldDescriptor field)
        Description copied from interface: MessageOrBuilder
        Gets the number of elements of a repeated field. This is exactly equivalent to calling the generated "Count" accessor method corresponding to the field.

      • getRepeatedField

        public java.lang.Object getRepeatedField​(Descriptors.FieldDescriptor field,
                                         int index)
        Description copied from interface: MessageOrBuilder
        Gets an element of a repeated field. For primitive fields, the boxed primitive value is returned. For enum fields, the EnumValueDescriptor for the value is returned. For embedded message fields, the sub-message is returned.