Package com.google.protobuf

Class DescriptorProtos.FieldOptions

    • Method Detail

      • hasCtype

        public boolean hasCtype()
         The ctype option instructs the C++ code generator to use a different
 representation of the field than it normally would.  See the specific
 options below.  This option is not yet implemented in the open source
 release -- sorry, we'll try to include it in a future version!
        optional .google.protobuf.FieldOptions.CType ctype = 1 [default = STRING];
        Specified by:
        hasCtype in interface DescriptorProtos.FieldOptionsOrBuilder
        Returns:
        Whether the ctype field is set.

      • getCtype

        public DescriptorProtos.FieldOptions.CType getCtype()
         The ctype option instructs the C++ code generator to use a different
 representation of the field than it normally would.  See the specific
 options below.  This option is not yet implemented in the open source
 release -- sorry, we'll try to include it in a future version!
        optional .google.protobuf.FieldOptions.CType ctype = 1 [default = STRING];
        Specified by:
        getCtype in interface DescriptorProtos.FieldOptionsOrBuilder
        Returns:
        The ctype.

      • hasPacked

        public boolean hasPacked()
         The packed option can be enabled for repeated primitive fields to enable
 a more efficient representation on the wire. Rather than repeatedly
 writing the tag and type for each element, the entire array is encoded as
 a single length-delimited blob. In proto3, only explicit setting it to
 false will avoid using packed encoding.
        optional bool packed = 2;
        Specified by:
        hasPacked in interface DescriptorProtos.FieldOptionsOrBuilder
        Returns:
        Whether the packed field is set.

      • getPacked

        public boolean getPacked()
         The packed option can be enabled for repeated primitive fields to enable
 a more efficient representation on the wire. Rather than repeatedly
 writing the tag and type for each element, the entire array is encoded as
 a single length-delimited blob. In proto3, only explicit setting it to
 false will avoid using packed encoding.
        optional bool packed = 2;
        Specified by:
        getPacked in interface DescriptorProtos.FieldOptionsOrBuilder
        Returns:
        The packed.

      • hasJstype

        public boolean hasJstype()
         The jstype option determines the JavaScript type used for values of the
 field.  The option is permitted only for 64 bit integral and fixed types
 (int64, uint64, sint64, fixed64, sfixed64).  A field with jstype JS_STRING
 is represented as JavaScript string, which avoids loss of precision that
 can happen when a large value is converted to a floating point JavaScript.
 Specifying JS_NUMBER for the jstype causes the generated JavaScript code to
 use the JavaScript "number" type.  The behavior of the default option
 JS_NORMAL is implementation dependent.
 This option is an enum to permit additional types to be added, e.g.
 goog.math.Integer.
        optional .google.protobuf.FieldOptions.JSType jstype = 6 [default = JS_NORMAL];
        Specified by:
        hasJstype in interface DescriptorProtos.FieldOptionsOrBuilder
        Returns:
        Whether the jstype field is set.

      • getJstype

        public DescriptorProtos.FieldOptions.JSType getJstype()
         The jstype option determines the JavaScript type used for values of the
 field.  The option is permitted only for 64 bit integral and fixed types
 (int64, uint64, sint64, fixed64, sfixed64).  A field with jstype JS_STRING
 is represented as JavaScript string, which avoids loss of precision that
 can happen when a large value is converted to a floating point JavaScript.
 Specifying JS_NUMBER for the jstype causes the generated JavaScript code to
 use the JavaScript "number" type.  The behavior of the default option
 JS_NORMAL is implementation dependent.
 This option is an enum to permit additional types to be added, e.g.
 goog.math.Integer.
        optional .google.protobuf.FieldOptions.JSType jstype = 6 [default = JS_NORMAL];
        Specified by:
        getJstype in interface DescriptorProtos.FieldOptionsOrBuilder
        Returns:
        The jstype.

      • hasLazy

        public boolean hasLazy()
         Should this field be parsed lazily?  Lazy applies only to message-type
 fields.  It means that when the outer message is initially parsed, the
 inner message's contents will not be parsed but instead stored in encoded
 form.  The inner message will actually be parsed when it is first accessed.
 This is only a hint.  Implementations are free to choose whether to use
 eager or lazy parsing regardless of the value of this option.  However,
 setting this option true suggests that the protocol author believes that
 using lazy parsing on this field is worth the additional bookkeeping
 overhead typically needed to implement it.
 This option does not affect the public interface of any generated code;
 all method signatures remain the same.  Furthermore, thread-safety of the
 interface is not affected by this option; const methods remain safe to
 call from multiple threads concurrently, while non-const methods continue
 to require exclusive access.
 Note that implementations may choose not to check required fields within
 a lazy sub-message.  That is, calling IsInitialized() on the outer message
 may return true even if the inner message has missing required fields.
 This is necessary because otherwise the inner message would have to be
 parsed in order to perform the check, defeating the purpose of lazy
 parsing.  An implementation which chooses not to check required fields
 must be consistent about it.  That is, for any particular sub-message, the
 implementation must either *always* check its required fields, or *never*
 check its required fields, regardless of whether or not the message has
 been parsed.
        optional bool lazy = 5 [default = false];
        Specified by:
        hasLazy in interface DescriptorProtos.FieldOptionsOrBuilder
        Returns:
        Whether the lazy field is set.

      • getLazy

        public boolean getLazy()
         Should this field be parsed lazily?  Lazy applies only to message-type
 fields.  It means that when the outer message is initially parsed, the
 inner message's contents will not be parsed but instead stored in encoded
 form.  The inner message will actually be parsed when it is first accessed.
 This is only a hint.  Implementations are free to choose whether to use
 eager or lazy parsing regardless of the value of this option.  However,
 setting this option true suggests that the protocol author believes that
 using lazy parsing on this field is worth the additional bookkeeping
 overhead typically needed to implement it.
 This option does not affect the public interface of any generated code;
 all method signatures remain the same.  Furthermore, thread-safety of the
 interface is not affected by this option; const methods remain safe to
 call from multiple threads concurrently, while non-const methods continue
 to require exclusive access.
 Note that implementations may choose not to check required fields within
 a lazy sub-message.  That is, calling IsInitialized() on the outer message
 may return true even if the inner message has missing required fields.
 This is necessary because otherwise the inner message would have to be
 parsed in order to perform the check, defeating the purpose of lazy
 parsing.  An implementation which chooses not to check required fields
 must be consistent about it.  That is, for any particular sub-message, the
 implementation must either *always* check its required fields, or *never*
 check its required fields, regardless of whether or not the message has
 been parsed.
        optional bool lazy = 5 [default = false];
        Specified by:
        getLazy in interface DescriptorProtos.FieldOptionsOrBuilder
        Returns:
        The lazy.

      • hasDeprecated

        public boolean hasDeprecated()
         Is this field deprecated?
 Depending on the target platform, this can emit Deprecated annotations
 for accessors, or it will be completely ignored; in the very least, this
 is a formalization for deprecating fields.
        optional bool deprecated = 3 [default = false];
        Specified by:
        hasDeprecated in interface DescriptorProtos.FieldOptionsOrBuilder
        Returns:
        Whether the deprecated field is set.

      • getDeprecated

        public boolean getDeprecated()
         Is this field deprecated?
 Depending on the target platform, this can emit Deprecated annotations
 for accessors, or it will be completely ignored; in the very least, this
 is a formalization for deprecating fields.
        optional bool deprecated = 3 [default = false];
        Specified by:
        getDeprecated in interface DescriptorProtos.FieldOptionsOrBuilder
        Returns:
        The deprecated.

      • hasWeak

        public boolean hasWeak()
         For Google-internal migration only. Do not use.
        optional bool weak = 10 [default = false];
        Specified by:
        hasWeak in interface DescriptorProtos.FieldOptionsOrBuilder
        Returns:
        Whether the weak field is set.

      • equals

        public boolean equals​(java.lang.Object obj)
        Description copied from interface: Message
        Compares the specified object with this message for equality. Returns true if the given object is a message of the same type (as defined by getDescriptorForType()) and has identical values for all of its fields. Subclasses must implement this; inheriting Object.equals() is incorrect.
        Specified by:
        equals in interface Message
        Overrides:
        equals in class AbstractMessage
        Parameters:
        obj - object to be compared for equality with this message
        Returns:
        true if the specified object is equal to this message

      • hashCode

        public int hashCode()
        Description copied from interface: Message
        Returns the hash code value for this message. The hash code of a message should mix the message's type (object identity of the descriptor) with its contents (known and unknown field values). Subclasses must implement this; inheriting Object.hashCode() is incorrect.
        Specified by:
        hashCode in interface Message
        Overrides:
        hashCode in class AbstractMessage
        Returns:
        the hash code value for this message
        See Also:
        Map.hashCode()

      • parseFrom

        public static DescriptorProtos.FieldOptions parseFrom​(java.io.InputStream input)
                                               throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static DescriptorProtos.FieldOptions parseDelimitedFrom​(java.io.InputStream input)
                                                        throws java.io.IOException
        Throws:
        java.io.IOException