Mixin.Builder (Protocol Buffers [Core] 3.5.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<Mixin.Builder>
    - - com.google.protobuf.Mixin.Builder

All Implemented Interfaces:: Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, MixinOrBuilder, Cloneable

Enclosing class:: Mixin

public static final class Mixin.Builder
extends GeneratedMessageV3.Builder<Mixin.Builder>
implements MixinOrBuilder

 Declares an API Interface to be included in this interface. The including
 interface must redeclare all the methods from the included interface, but
 documentation and options are inherited as follows:
 - If after comment and whitespace stripping, the documentation
   string of the redeclared method is empty, it will be inherited
   from the original method.
 - Each annotation belonging to the service config (http,
   visibility) which is not set in the redeclared method will be
   inherited.
 - If an http annotation is inherited, the path pattern will be
   modified as follows. Any version prefix will be replaced by the
   version of the including interface plus the [root][] path if
   specified.
 Example of a simple mixin:
     package google.acl.v1;
     service AccessControl {
       // Get the underlying ACL object.
       rpc GetAcl(GetAclRequest) returns (Acl) {
         option (google.api.http).get = "/v1/{resource=**}:getAcl";
       }
     }
     package google.storage.v2;
     service Storage {
       rpc GetAcl(GetAclRequest) returns (Acl);
       // Get a data record.
       rpc GetData(GetDataRequest) returns (Data) {
         option (google.api.http).get = "/v2/{resource=**}";
       }
     }
 Example of a mixin configuration:
     apis:
     - name: google.storage.v2.Storage
       mixins:
       - name: google.acl.v1.AccessControl
 The mixin construct implies that all methods in `AccessControl` are
 also declared with same name and request/response types in
 `Storage`. A documentation generator or annotation processor will
 see the effective `Storage.GetAcl` method after inherting
 documentation and annotations as follows:
     service Storage {
       // Get the underlying ACL object.
       rpc GetAcl(GetAclRequest) returns (Acl) {
         option (google.api.http).get = "/v2/{resource=**}:getAcl";
       }
       ...
     }
 Note how the version in the path pattern changed from `v1` to `v2`.
 If the `root` field in the mixin is specified, it should be a
 relative path under which inherited HTTP paths are placed. Example:
     apis:
     - name: google.storage.v2.Storage
       mixins:
       - name: google.acl.v1.AccessControl
         root: acls
 This implies the following inherited HTTP annotation:
     service Storage {
       // Get the underlying ACL object.
       rpc GetAcl(GetAclRequest) returns (Acl) {
         option (google.api.http).get = "/v2/acls/{resource=**}:getAcl";
       }
       ...
     }

Protobuf type google.protobuf.Mixin

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Mixin.Builder`	`addRepeatedField(Descriptors.FieldDescriptor field, Object value)` Like `setRepeatedField`, but appends the value as a new element.
`Mixin`	`build()` Constructs the message based on the state of the Builder.
`Mixin`	`buildPartial()` Like `MessageLite.Builder.build()`, but does not throw an exception if the message is missing required fields.
`Mixin.Builder`	`clear()` Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.
`Mixin.Builder`	`clearField(Descriptors.FieldDescriptor field)` Clears the field.
`Mixin.Builder`	`clearName()` The fully qualified name of the interface which is included.
`Mixin.Builder`	`clearOneof(Descriptors.OneofDescriptor oneof)` TODO(jieluo): Clear it when all subclasses have implemented this method.
`Mixin.Builder`	`clearRoot()` If non-empty specifies a path under which inherited HTTP paths are rooted.
`Mixin.Builder`	`clone()` Clones the Builder.
`Mixin`	`getDefaultInstanceForType()` Get an instance of the type with no fields set.
`static Descriptors.Descriptor`	`getDescriptor()`
`Descriptors.Descriptor`	`getDescriptorForType()` Get the message's type's descriptor.
`String`	`getName()` The fully qualified name of the interface which is included.
`ByteString`	`getNameBytes()` The fully qualified name of the interface which is included.
`String`	`getRoot()` If non-empty specifies a path under which inherited HTTP paths are rooted.
`ByteString`	`getRootBytes()` If non-empty specifies a path under which inherited HTTP paths are rooted.
`protected GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()` Get the FieldAccessorTable for this type.
`boolean`	`isInitialized()` Returns true if all required fields in the message and all embedded messages are set, false otherwise.
`Mixin.Builder`	`mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)` Like `MessageLite.Builder.mergeFrom(CodedInputStream)`, but also parses extensions.
`Mixin.Builder`	`mergeFrom(Message other)` Merge `other` into the message being built.
`Mixin.Builder`	`mergeFrom(Mixin other)`
`Mixin.Builder`	`mergeUnknownFields(UnknownFieldSet unknownFields)` Merge some unknown fields into the `UnknownFieldSet` for this message.
`Mixin.Builder`	`setField(Descriptors.FieldDescriptor field, Object value)` Sets a field to the given value.
`Mixin.Builder`	`setName(String value)` The fully qualified name of the interface which is included.
`Mixin.Builder`	`setNameBytes(ByteString value)` The fully qualified name of the interface which is included.
`Mixin.Builder`	`setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)` Sets an element of a repeated field to the given value.
`Mixin.Builder`	`setRoot(String value)` If non-empty specifies a path under which inherited HTTP paths are rooted.
`Mixin.Builder`	`setRootBytes(ByteString value)` If non-empty specifies a path under which inherited HTTP paths are rooted.
`Mixin.Builder`	`setUnknownFields(UnknownFieldSet unknownFields)` Set the `UnknownFieldSet` for this message.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

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

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

- Method Detail
  - getDescriptor
```
public static final Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    Description copied from class: GeneratedMessageV3.Builder
    
    Get the FieldAccessorTable for this type. We can't have the message class pass this in to the constructor because of bootstrapping trouble with DescriptorProtos.
    
    Specified by:
    
    internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<Mixin.Builder>
  - clear
```
public Mixin.Builder clear()
```
    Description copied from class: GeneratedMessageV3.Builder
    
    Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.
    
    Specified by:
    
    clear in interface Message.Builder
    
    Specified by:
    
    clear in interface MessageLite.Builder
    
    Overrides:
    
    clear in class GeneratedMessageV3.Builder<Mixin.Builder>
  - getDescriptorForType
```
public Descriptors.Descriptor getDescriptorForType()
```
    Description copied from interface: Message.Builder
    
    Get the message's type's descriptor. See MessageOrBuilder.getDescriptorForType().
    
    Specified by:
    
    getDescriptorForType in interface Message.Builder
    
    Specified by:
    
    getDescriptorForType in interface MessageOrBuilder
    
    Overrides:
    
    getDescriptorForType in class GeneratedMessageV3.Builder<Mixin.Builder>
  - getDefaultInstanceForType
```
public Mixin 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.
    
    Specified by:
    
    getDefaultInstanceForType in interface MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface MessageOrBuilder
  - build
```
public Mixin build()
```
    Description copied from interface: MessageLite.Builder
    
    Constructs the message based on the state of the Builder. Subsequent changes to the Builder will not affect the returned message.
    
    Specified by:
    
    build in interface Message.Builder
    
    Specified by:
    
    build in interface MessageLite.Builder
  - buildPartial
```
public Mixin buildPartial()
```
    Description copied from interface: MessageLite.Builder
    
    Like MessageLite.Builder.build(), but does not throw an exception if the message is missing required fields. Instead, a partial message is returned. Subsequent changes to the Builder will not affect the returned message.
    
    Specified by:
    
    buildPartial in interface Message.Builder
    
    Specified by:
    
    buildPartial in interface MessageLite.Builder
  - clone
```
public Mixin.Builder clone()
```
    Description copied from interface: MessageLite.Builder
    
    Clones the Builder.
    
    Specified by:
    
    clone in interface Message.Builder
    
    Specified by:
    
    clone in interface MessageLite.Builder
    
    Overrides:
    
    clone in class GeneratedMessageV3.Builder<Mixin.Builder>
    
    See Also:
    
    Object.clone()
  - setField
```
public Mixin.Builder setField(Descriptors.FieldDescriptor field,
                              Object value)
```
    Description copied from interface: Message.Builder
    
    Sets a field to the given value. The value must be of the correct type for this field, i.e. the same type that MessageOrBuilder.getField(Descriptors.FieldDescriptor) would return.
    
    Specified by:
    
    setField in interface Message.Builder
    
    Overrides:
    
    setField in class GeneratedMessageV3.Builder<Mixin.Builder>
  - clearField
```
public Mixin.Builder clearField(Descriptors.FieldDescriptor field)
```
    Description copied from interface: Message.Builder
    
    Clears the field. This is exactly equivalent to calling the generated "clear" accessor method corresponding to the field.
    
    Specified by:
    
    clearField in interface Message.Builder
    
    Overrides:
    
    clearField in class GeneratedMessageV3.Builder<Mixin.Builder>
  - clearOneof
```
public Mixin.Builder clearOneof(Descriptors.OneofDescriptor oneof)
```
    Description copied from class: AbstractMessage.Builder
    
    TODO(jieluo): Clear it when all subclasses have implemented this method.
    
    Specified by:
    
    clearOneof in interface Message.Builder
    
    Overrides:
    
    clearOneof in class GeneratedMessageV3.Builder<Mixin.Builder>
  - setRepeatedField
```
public Mixin.Builder setRepeatedField(Descriptors.FieldDescriptor field,
                                      int index,
                                      Object value)
```
    Description copied from interface: Message.Builder
    
    Sets an element of a repeated field to the given value. The value must be of the correct type for this field, i.e. the same type that MessageOrBuilder.getRepeatedField(Descriptors.FieldDescriptor,int) would return.
    
    Specified by:
    
    setRepeatedField in interface Message.Builder
    
    Overrides:
    
    setRepeatedField in class GeneratedMessageV3.Builder<Mixin.Builder>
  - addRepeatedField
```
public Mixin.Builder addRepeatedField(Descriptors.FieldDescriptor field,
                                      Object value)
```
    Description copied from interface: Message.Builder
    
    Like setRepeatedField, but appends the value as a new element.
    
    Specified by:
    
    addRepeatedField in interface Message.Builder
    
    Overrides:
    
    addRepeatedField in class GeneratedMessageV3.Builder<Mixin.Builder>
  - mergeFrom
```
public Mixin.Builder mergeFrom(Message other)
```
    Description copied from interface: Message.Builder
    
    Merge other into the message being built. other must have the exact same type as this (i.e. getDescriptorForType() == other.getDescriptorForType()). Merging occurs as follows. For each field:
    * For singular primitive fields, if the field is set in other, then other's value overwrites the value in this message.
    * For singular message fields, if the field is set in other, it is merged into the corresponding sub-message of this message using the same merging rules.
    * For repeated fields, the elements in other are concatenated with the elements in this message.
    * For oneof groups, if the other message has one of the fields set, the group of this message is cleared and replaced by the field of the other message, so that the oneof constraint is preserved. This is equivalent to the Message::MergeFrom method in C++.
    
    Specified by:
    
    mergeFrom in interface Message.Builder
    
    Overrides:
    
    mergeFrom in class AbstractMessage.Builder<Mixin.Builder>
  - mergeFrom
```
public Mixin.Builder mergeFrom(Mixin other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Description copied from interface: MessageLiteOrBuilder
    
    Returns true if all required fields in the message and all embedded messages are set, false otherwise.
    See also: MessageOrBuilder.getInitializationErrorString()
    
    Specified by:
    
    isInitialized in interface MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class GeneratedMessageV3.Builder<Mixin.Builder>
  - mergeFrom
```
public Mixin.Builder mergeFrom(CodedInputStream input,
                               ExtensionRegistryLite extensionRegistry)
                        throws IOException
```
    Description copied from interface: MessageLite.Builder
    
    Like MessageLite.Builder.mergeFrom(CodedInputStream), but also parses extensions. The extensions that you want to be able to parse must be registered in extensionRegistry. Extensions not in the registry will be treated as unknown fields.
    
    Specified by:
    
    mergeFrom in interface Message.Builder
    
    Specified by:
    
    mergeFrom in interface MessageLite.Builder
    
    Overrides:
    
    mergeFrom in class AbstractMessage.Builder<Mixin.Builder>
    
    Throws:
    
    IOException
  - getName
```
public String getName()
```
```
 The fully qualified name of the interface which is included.
 
```
    string name = 1;
    Specified by:
    
    getName in interface MixinOrBuilder
  - getNameBytes
```
public ByteString getNameBytes()
```
```
 The fully qualified name of the interface which is included.
 
```
    string name = 1;
    Specified by:
    
    getNameBytes in interface MixinOrBuilder
  - setName
```
public Mixin.Builder setName(String value)
```
```
 The fully qualified name of the interface which is included.
 
```
    string name = 1;
  - clearName
```
public Mixin.Builder clearName()
```
```
 The fully qualified name of the interface which is included.
 
```
    string name = 1;
  - setNameBytes
```
public Mixin.Builder setNameBytes(ByteString value)
```
```
 The fully qualified name of the interface which is included.
 
```
    string name = 1;
  - getRoot
```
public String getRoot()
```
```
 If non-empty specifies a path under which inherited HTTP paths
 are rooted.
 
```
    string root = 2;
    Specified by:
    
    getRoot in interface MixinOrBuilder
  - getRootBytes
```
public ByteString getRootBytes()
```
```
 If non-empty specifies a path under which inherited HTTP paths
 are rooted.
 
```
    string root = 2;
    Specified by:
    
    getRootBytes in interface MixinOrBuilder
  - setRoot
```
public Mixin.Builder setRoot(String value)
```
```
 If non-empty specifies a path under which inherited HTTP paths
 are rooted.
 
```
    string root = 2;
  - clearRoot
```
public Mixin.Builder clearRoot()
```
```
 If non-empty specifies a path under which inherited HTTP paths
 are rooted.
 
```
    string root = 2;
  - setRootBytes
```
public Mixin.Builder setRootBytes(ByteString value)
```
```
 If non-empty specifies a path under which inherited HTTP paths
 are rooted.
 
```
    string root = 2;
  - setUnknownFields
```
public final Mixin.Builder setUnknownFields(UnknownFieldSet unknownFields)
```
    Description copied from interface: Message.Builder
    
    Set the UnknownFieldSet for this message.
    
    Specified by:
    
    setUnknownFields in interface Message.Builder
    
    Overrides:
    
    setUnknownFields in class GeneratedMessageV3.Builder<Mixin.Builder>
  - mergeUnknownFields
```
public final Mixin.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
```
    Description copied from interface: Message.Builder
    
    Merge some unknown fields into the UnknownFieldSet for this message.
    
    Specified by:
    
    mergeUnknownFields in interface Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class GeneratedMessageV3.Builder<Mixin.Builder>

Class Mixin.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLite.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getName

getNameBytes

setName

clearName

setNameBytes

getRoot

getRootBytes

setRoot

clearRoot

setRootBytes

setUnknownFields

mergeUnknownFields