com.google.protobuf

Class Mixin

java.lang.Object

com.google.protobuf.AbstractMessageLite<MessageType,BuilderType>

com.google.protobuf.GeneratedMessageLite<Mixin,Mixin.Builder>

com.google.protobuf.Mixin

All Implemented Interfaces:

MessageLite, MessageLiteOrBuilder, MixinOrBuilder

public final class Mixin
extends GeneratedMessageLite<Mixin,Mixin.Builder>
implements MixinOrBuilder

 Declares an API to be included in this API. The including API must
 redeclare all the methods from the included API, 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 API 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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Mixin.Builder Declares an API to be included in this API.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageLite

GeneratedMessageLite.DefaultInstanceBasedParser<T extends GeneratedMessageLite<T,?>>, GeneratedMessageLite.ExtendableBuilder<MessageType extends GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageLite.ExtendableMessage<MessageType extends GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageLite.GeneratedExtension<ContainingType extends MessageLite,Type>, GeneratedMessageLite.MergeFromVisitor, GeneratedMessageLite.MethodToInvoke, GeneratedMessageLite.SerializedForm, GeneratedMessageLite.Visitor

Field Summary

Fields

Modifier and Type	Field and Description
static int	NAME_FIELD_NUMBER
static int	ROOT_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageLite

memoizedSerializedSize, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
protected Object	dynamicMethod(GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1) A method that implements different types of operations described in GeneratedMessageLite.MethodToInvoke.
static Mixin	getDefaultInstance()
String	getName() The fully qualified name of the API which is included.
ByteString	getNameBytes() The fully qualified name of the API 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.
int	getSerializedSize() Get the number of bytes required to encode this message.
static Mixin.Builder	newBuilder()
static Mixin.Builder	newBuilder(Mixin prototype)
static Mixin	parseDelimitedFrom(InputStream input)
static Mixin	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Mixin	parseFrom(byte[] data)
static Mixin	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static Mixin	parseFrom(ByteString data)
static Mixin	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static Mixin	parseFrom(CodedInputStream input)
static Mixin	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static Mixin	parseFrom(InputStream input)
static Mixin	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<Mixin>	parser()
void	writeTo(CodedOutputStream output) Serializes the message and writes it to output.

Methods inherited from class com.google.protobuf.GeneratedMessageLite

dynamicMethod, dynamicMethod, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstanceForType, getParserForType, hashCode, isInitialized, isInitialized, makeImmutable, makeImmutable, mergeLengthDelimitedField, mergeUnknownFields, mergeVarintField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseDelimitedFrom, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parsePartialFrom, parseUnknownField, toBuilder, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

getDefaultInstanceForType, isInitialized

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

ROOT_FIELD_NUMBER

public static final int ROOT_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getName

public String getName()

 The fully qualified name of the API which is included.
 

optional string name = 1;

Specified by:

getName in interface MixinOrBuilder

getNameBytes

public ByteString getNameBytes()

 The fully qualified name of the API which is included.
 

optional string name = 1;

Specified by:

getNameBytes in interface MixinOrBuilder

getRoot

public String getRoot()

 If non-empty specifies a path under which inherited HTTP paths
 are rooted.
 

optional 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.
 

optional string root = 2;

Specified by:

getRootBytes in interface MixinOrBuilder

writeTo

public void writeTo(CodedOutputStream output)
             throws 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

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Description copied from interface: MessageLite

Get the number of bytes required to encode this message. The result is only computed on the first call and memoized after that.

Specified by:

getSerializedSize in interface MessageLite

parseFrom

public static Mixin parseFrom(ByteString data)
                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Mixin parseFrom(ByteString data,
                              ExtensionRegistryLite extensionRegistry)
                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Mixin parseFrom(byte[] data)
                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Mixin parseFrom(byte[] data,
                              ExtensionRegistryLite extensionRegistry)
                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Mixin parseFrom(InputStream input)
                       throws IOException

Throws:

IOException

parseFrom

public static Mixin parseFrom(InputStream input,
                              ExtensionRegistryLite extensionRegistry)
                       throws IOException

Throws:

IOException

parseDelimitedFrom

public static Mixin parseDelimitedFrom(InputStream input)
                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static Mixin parseDelimitedFrom(InputStream input,
                                       ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

parseFrom

public static Mixin parseFrom(CodedInputStream input)
                       throws IOException

Throws:

IOException

parseFrom

public static Mixin parseFrom(CodedInputStream input,
                              ExtensionRegistryLite extensionRegistry)
                       throws IOException

Throws:

IOException

newBuilder

public static Mixin.Builder newBuilder()

newBuilder

public static Mixin.Builder newBuilder(Mixin prototype)

dynamicMethod

protected final Object dynamicMethod(GeneratedMessageLite.MethodToInvoke method,
                                     Object arg0,
                                     Object arg1)

Description copied from class: GeneratedMessageLite

A method that implements different types of operations described in GeneratedMessageLite.MethodToInvoke. Theses different kinds of operations are required to implement message-level operations for builders in the runtime. This method bundles those operations to reduce the generated methods count.

• MERGE_FROM_STREAM is parameterized with an CodedInputStream and ExtensionRegistryLite. It consumes the input stream, parsing the contents into the returned protocol buffer. If parsing throws an InvalidProtocolBufferException, the implementation wraps it in a RuntimeException.
• NEW_INSTANCE returns a new instance of the protocol buffer that has not yet been made immutable. See MAKE_IMMUTABLE.
• IS_INITIALIZED is parameterized with a Boolean detailing whether to memoize. It returns null for false and the default instance for true. We optionally memoize to support the Builder case, where memoization is not desired.
• NEW_BUILDER returns a BuilderType instance.
• VISIT is parameterized with a Visitor and a MessageType and recursively iterates through the fields side by side between this and the instance.
• MAKE_IMMUTABLE sets all internal fields to an immutable state.

This method, plus the implementation of the Builder, enables the Builder class to be proguarded away entirely on Android.

For use by generated code only.

Specified by:

dynamicMethod in class GeneratedMessageLite<Mixin,Mixin.Builder>

getDefaultInstance

public static Mixin getDefaultInstance()

parser

public static Parser<Mixin> parser()