DescriptorProtos.FieldOptions.Builder (Protocol Buffers [Lite] 3.0.1 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder<MessageType,BuilderType>
- - com.google.protobuf.GeneratedMessageLite.Builder<MessageType,BuilderType>
  - - com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<DescriptorProtos.FieldOptions,DescriptorProtos.FieldOptions.Builder>
    - - com.google.protobuf.DescriptorProtos.FieldOptions.Builder

All Implemented Interfaces:

DescriptorProtos.FieldOptionsOrBuilder, GeneratedMessageLite.ExtendableMessageOrBuilder<DescriptorProtos.FieldOptions,DescriptorProtos.FieldOptions.Builder>, MessageLite.Builder, MessageLiteOrBuilder, Cloneable

Enclosing class:

DescriptorProtos.FieldOptions
```
public static final class DescriptorProtos.FieldOptions.Builder
extends GeneratedMessageLite.ExtendableBuilder<DescriptorProtos.FieldOptions,DescriptorProtos.FieldOptions.Builder>
implements DescriptorProtos.FieldOptionsOrBuilder
```
Protobuf type google.protobuf.FieldOptions

Field Summary
- Fields inherited from class com.google.protobuf.GeneratedMessageLite.Builder
  instance, isBuilt

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescriptorProtos.FieldOptions.Builder`	`addAllUninterpretedOption(Iterable<? extends DescriptorProtos.UninterpretedOption> values)` The parser stores options it doesn't recognize here.
`DescriptorProtos.FieldOptions.Builder`	`addUninterpretedOption(DescriptorProtos.UninterpretedOption.Builder builderForValue)` The parser stores options it doesn't recognize here.
`DescriptorProtos.FieldOptions.Builder`	`addUninterpretedOption(DescriptorProtos.UninterpretedOption value)` The parser stores options it doesn't recognize here.
`DescriptorProtos.FieldOptions.Builder`	`addUninterpretedOption(int index, DescriptorProtos.UninterpretedOption.Builder builderForValue)` The parser stores options it doesn't recognize here.
`DescriptorProtos.FieldOptions.Builder`	`addUninterpretedOption(int index, DescriptorProtos.UninterpretedOption value)` The parser stores options it doesn't recognize here.
`DescriptorProtos.FieldOptions.Builder`	`clearCtype()` The ctype option instructs the C++ code generator to use a different representation of the field than it normally would.
`DescriptorProtos.FieldOptions.Builder`	`clearDeprecated()` 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.
`DescriptorProtos.FieldOptions.Builder`	`clearJstype()` The jstype option determines the JavaScript type used for values of the field.
`DescriptorProtos.FieldOptions.Builder`	`clearLazy()` Should this field be parsed lazily? Lazy applies only to message-type fields.
`DescriptorProtos.FieldOptions.Builder`	`clearPacked()` The packed option can be enabled for repeated primitive fields to enable a more efficient representation on the wire.
`DescriptorProtos.FieldOptions.Builder`	`clearUninterpretedOption()` The parser stores options it doesn't recognize here.
`DescriptorProtos.FieldOptions.Builder`	`clearWeak()` For Google-internal migration only.
`DescriptorProtos.FieldOptions.CType`	`getCtype()` The ctype option instructs the C++ code generator to use a different representation of the field than it normally would.
`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.
`DescriptorProtos.FieldOptions.JSType`	`getJstype()` The jstype option determines the JavaScript type used for values of the field.
`boolean`	`getLazy()` Should this field be parsed lazily? Lazy applies only to message-type fields.
`boolean`	`getPacked()` The packed option can be enabled for repeated primitive fields to enable a more efficient representation on the wire.
`DescriptorProtos.UninterpretedOption`	`getUninterpretedOption(int index)` The parser stores options it doesn't recognize here.
`int`	`getUninterpretedOptionCount()` The parser stores options it doesn't recognize here.
`List<DescriptorProtos.UninterpretedOption>`	`getUninterpretedOptionList()` The parser stores options it doesn't recognize here.
`boolean`	`getWeak()` For Google-internal migration only.
`boolean`	`hasCtype()` The ctype option instructs the C++ code generator to use a different representation of the field than it normally would.
`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.
`boolean`	`hasJstype()` The jstype option determines the JavaScript type used for values of the field.
`boolean`	`hasLazy()` Should this field be parsed lazily? Lazy applies only to message-type fields.
`boolean`	`hasPacked()` The packed option can be enabled for repeated primitive fields to enable a more efficient representation on the wire.
`boolean`	`hasWeak()` For Google-internal migration only.
`DescriptorProtos.FieldOptions.Builder`	`removeUninterpretedOption(int index)` The parser stores options it doesn't recognize here.
`DescriptorProtos.FieldOptions.Builder`	`setCtype(DescriptorProtos.FieldOptions.CType value)` The ctype option instructs the C++ code generator to use a different representation of the field than it normally would.
`DescriptorProtos.FieldOptions.Builder`	`setDeprecated(boolean value)` 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.
`DescriptorProtos.FieldOptions.Builder`	`setJstype(DescriptorProtos.FieldOptions.JSType value)` The jstype option determines the JavaScript type used for values of the field.
`DescriptorProtos.FieldOptions.Builder`	`setLazy(boolean value)` Should this field be parsed lazily? Lazy applies only to message-type fields.
`DescriptorProtos.FieldOptions.Builder`	`setPacked(boolean value)` The packed option can be enabled for repeated primitive fields to enable a more efficient representation on the wire.
`DescriptorProtos.FieldOptions.Builder`	`setUninterpretedOption(int index, DescriptorProtos.UninterpretedOption.Builder builderForValue)` The parser stores options it doesn't recognize here.
`DescriptorProtos.FieldOptions.Builder`	`setUninterpretedOption(int index, DescriptorProtos.UninterpretedOption value)` The parser stores options it doesn't recognize here.
`DescriptorProtos.FieldOptions.Builder`	`setWeak(boolean value)` For Google-internal migration only.

Methods inherited from class com.google.protobuf.GeneratedMessageLite.ExtendableBuilder
addExtension, buildPartial, clearExtension, clone, copyOnWrite, getExtension, getExtension, getExtensionCount, hasExtension, setExtension, setExtension

Methods inherited from class com.google.protobuf.GeneratedMessageLite.Builder
build, clear, getDefaultInstanceForType, internalMergeFrom, isInitialized, mergeFrom, mergeFrom

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.google.protobuf.GeneratedMessageLite.ExtendableMessageOrBuilder
getExtension, getExtension, getExtensionCount, hasExtension

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType, isInitialized

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

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

setCtype

public DescriptorProtos.FieldOptions.Builder setCtype(DescriptorProtos.FieldOptions.CType value)

 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];

clearCtype

public DescriptorProtos.FieldOptions.Builder clearCtype()

 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];

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

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

setPacked

public DescriptorProtos.FieldOptions.Builder setPacked(boolean value)

 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;

clearPacked

public DescriptorProtos.FieldOptions.Builder clearPacked()

 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;

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).  By default these types are
 represented as JavaScript strings.  This avoids loss of precision that can
 happen when a large value is converted to a floating point JavaScript
 numbers.  Specifying JS_NUMBER for the jstype causes the generated
 JavaScript code to use the JavaScript "number" type instead of strings.
 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

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).  By default these types are
 represented as JavaScript strings.  This avoids loss of precision that can
 happen when a large value is converted to a floating point JavaScript
 numbers.  Specifying JS_NUMBER for the jstype causes the generated
 JavaScript code to use the JavaScript "number" type instead of strings.
 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

setJstype

public DescriptorProtos.FieldOptions.Builder setJstype(DescriptorProtos.FieldOptions.JSType value)

 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).  By default these types are
 represented as JavaScript strings.  This avoids loss of precision that can
 happen when a large value is converted to a floating point JavaScript
 numbers.  Specifying JS_NUMBER for the jstype causes the generated
 JavaScript code to use the JavaScript "number" type instead of strings.
 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];

clearJstype

public DescriptorProtos.FieldOptions.Builder clearJstype()

 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).  By default these types are
 represented as JavaScript strings.  This avoids loss of precision that can
 happen when a large value is converted to a floating point JavaScript
 numbers.  Specifying JS_NUMBER for the jstype causes the generated
 JavaScript code to use the JavaScript "number" type instead of strings.
 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];

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 outher 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

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 outher 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

setLazy

public DescriptorProtos.FieldOptions.Builder setLazy(boolean value)

 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 outher 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];

clearLazy

public DescriptorProtos.FieldOptions.Builder clearLazy()

 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 outher 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];

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

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

setDeprecated

public DescriptorProtos.FieldOptions.Builder setDeprecated(boolean value)

 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];

clearDeprecated

public DescriptorProtos.FieldOptions.Builder clearDeprecated()

 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];

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

getWeak
```
public boolean getWeak()
```
```
 For Google-internal migration only. Do not use.
 
```
optional bool weak = 10 [default = false];
Specified by:

getWeak in interface DescriptorProtos.FieldOptionsOrBuilder

setWeak

public DescriptorProtos.FieldOptions.Builder setWeak(boolean value)

 For Google-internal migration only. Do not use.

optional bool weak = 10 [default = false];

clearWeak

public DescriptorProtos.FieldOptions.Builder clearWeak()

 For Google-internal migration only. Do not use.

optional bool weak = 10 [default = false];

getUninterpretedOptionList
```
public List<DescriptorProtos.UninterpretedOption> getUninterpretedOptionList()
```
```
 The parser stores options it doesn't recognize here. See above.
 
```
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
Specified by:

getUninterpretedOptionList in interface DescriptorProtos.FieldOptionsOrBuilder

getUninterpretedOptionCount
```
public int getUninterpretedOptionCount()
```
```
 The parser stores options it doesn't recognize here. See above.
 
```
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
Specified by:

getUninterpretedOptionCount in interface DescriptorProtos.FieldOptionsOrBuilder

getUninterpretedOption
```
public DescriptorProtos.UninterpretedOption getUninterpretedOption(int index)
```
```
 The parser stores options it doesn't recognize here. See above.
 
```
repeated .google.protobuf.UninterpretedOption uninterpreted_option = 999;
Specified by:

getUninterpretedOption in interface DescriptorProtos.FieldOptionsOrBuilder