Class Descriptors.ServiceDescriptor

java.lang.Object

com.google.protobuf.Descriptors.GenericDescriptor

com.google.protobuf.Descriptors.ServiceDescriptor

Enclosing class:

Descriptors

public static final class Descriptors.ServiceDescriptor
extends Descriptors.GenericDescriptor

Describes a service type.

Field Summary

Fields

Modifier and Type	Field	Description
private final Descriptors.FileDescriptor	file
private final String	fullName
private final int	index
private Descriptors.MethodDescriptor[]	methods
private DescriptorProtos.ServiceOptions	options
private DescriptorProtos.ServiceDescriptorProto	proto

Fields inherited from class Descriptors.GenericDescriptor

features

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ServiceDescriptor(DescriptorProtos.ServiceDescriptorProto proto, Descriptors.FileDescriptor file, int index)

Method Summary

Modifier and Type	Method	Description
private void	crossLink()
Descriptors.MethodDescriptor	findMethodByName(String name)	Find a method by name.
Descriptors.FileDescriptor	getFile()	Get the Descriptors.FileDescriptor containing this descriptor.
String	getFullName()	Get the type's fully-qualified name.
int	getIndex()	Get the index of this descriptor within its parent.
Descriptors.MethodDescriptor	getMethod(int index)	Get the service's method at the specified index.
int	getMethodCount()	Get a count of methods for this service.
List<Descriptors.MethodDescriptor>	getMethods()	Get a list of methods for this service.
String	getName()	Get the type's unqualified name.
DescriptorProtos.ServiceOptions	getOptions()	Get the ServiceOptions, defined in descriptor.proto.
(package private) Descriptors.GenericDescriptor	getParent()
private void	resolveAllFeatures()	See invalid reference FileDescriptor#resolveAllFeatures .
private void	setProto(DescriptorProtos.ServiceDescriptorProto proto)	See Descriptors.FileDescriptor.setProto(DescriptorProtos.FileDescriptorProto).
DescriptorProtos.ServiceDescriptorProto	toProto()	Convert the descriptor to its protocol message representation.

Methods inherited from class Descriptors.GenericDescriptor

getFeatures, inferLegacyProtoFeatures, resolveFeatures, validateFeatures

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

index

private final int index

proto

private DescriptorProtos.ServiceDescriptorProto proto

options

private volatile DescriptorProtos.ServiceOptions options

fullName

private final String fullName

file

private final Descriptors.FileDescriptor file

methods

private Descriptors.MethodDescriptor[] methods

Constructor Details

ServiceDescriptor

private ServiceDescriptor(DescriptorProtos.ServiceDescriptorProto proto,
 Descriptors.FileDescriptor file,
 int index)
                   throws Descriptors.DescriptorValidationException

Throws:

Descriptors.DescriptorValidationException

Method Details

getIndex

public int getIndex()

Get the index of this descriptor within its parent. * @see Descriptors.Descriptor#getIndex()

toProto

public DescriptorProtos.ServiceDescriptorProto toProto()

Convert the descriptor to its protocol message representation.

Specified by:

toProto in class Descriptors.GenericDescriptor

getName

public String getName()

Get the type's unqualified name.

Specified by:

getName in class Descriptors.GenericDescriptor

getFullName

public String getFullName()

Get the type's fully-qualified name.

Specified by:

getFullName in class Descriptors.GenericDescriptor

See Also:

• Descriptors.Descriptor.getFullName()

getFile

public Descriptors.FileDescriptor getFile()

Get the Descriptors.FileDescriptor containing this descriptor.

Specified by:

getFile in class Descriptors.GenericDescriptor

getParent

Descriptors.GenericDescriptor getParent()

Specified by:

getParent in class Descriptors.GenericDescriptor

getOptions

public DescriptorProtos.ServiceOptions getOptions()

Get the ServiceOptions, defined in descriptor.proto.

getMethods

public List<Descriptors.MethodDescriptor> getMethods()

Get a list of methods for this service.

getMethodCount

public int getMethodCount()

Get a count of methods for this service.

getMethod

public Descriptors.MethodDescriptor getMethod(int index)

Get the service's method at the specified index.

findMethodByName

public Descriptors.MethodDescriptor findMethodByName(String name)

Find a method by name.

Parameters:

name - the unqualified name of the method such as "Foo"

Returns:

the method's descriptor, or null if not found

resolveAllFeatures

private void resolveAllFeatures()
                         throws Descriptors.DescriptorValidationException

See

invalid reference

FileDescriptor#resolveAllFeatures

.

Throws:

Descriptors.DescriptorValidationException

crossLink

private void crossLink()
                throws Descriptors.DescriptorValidationException

Throws:

Descriptors.DescriptorValidationException

setProto

private void setProto(DescriptorProtos.ServiceDescriptorProto proto)
               throws Descriptors.DescriptorValidationException

See Descriptors.FileDescriptor.setProto(DescriptorProtos.FileDescriptorProto).

Throws:

Descriptors.DescriptorValidationException