Inheritance diagram for com.google.protobuf.ExtensionRegistry:

Classes
class	DescriptorIntPair

class	ExtensionInfo

Public Member Functions
void	add (final Extension<?, ?> extension)

void	add (final FieldDescriptor type)

void	add (final FieldDescriptor type, final Message defaultInstance)

void	add (final GeneratedMessage.GeneratedExtension<?, ?> extension)

ExtensionInfo	findExtensionByName (final String fullName)

ExtensionInfo	findExtensionByNumber (final Descriptor containingType, final int fieldNumber)

ExtensionInfo	findImmutableExtensionByName (final String fullName)

ExtensionInfo	findImmutableExtensionByNumber (final Descriptor containingType, final int fieldNumber)

ExtensionInfo	findMutableExtensionByName (final String fullName)

ExtensionInfo	findMutableExtensionByNumber (final Descriptor containingType, final int fieldNumber)

Set< ExtensionInfo >	getAllImmutableExtensionsByExtendedType (final String fullName)

Set< ExtensionInfo >	getAllMutableExtensionsByExtendedType (final String fullName)

ExtensionRegistry	getUnmodifiable ()

Public Member Functions inherited from com.google.protobuf.ExtensionRegistryLite
final void	add (ExtensionLite<?, ?> extension)

final void	add (final GeneratedMessageLite.GeneratedExtension<?, ?> extension)

Static Public Member Functions
static ExtensionRegistry	getEmptyRegistry ()

static ExtensionRegistry	newInstance ()

Static Public Member Functions inherited from com.google.protobuf.ExtensionRegistryLite
static boolean	isEagerlyParseMessageSets ()

static void	setEagerlyParseMessageSets (boolean isEagerlyParse)

Private Member Functions
void	add (final ExtensionInfo extension, final Extension.ExtensionType extensionType)

	ExtensionRegistry ()

	ExtensionRegistry (ExtensionRegistry other)

Private Attributes
final Map< String, ExtensionInfo >	immutableExtensionsByName

final Map< DescriptorIntPair, ExtensionInfo >	immutableExtensionsByNumber

final Map< String, ExtensionInfo >	mutableExtensionsByName

final Map< DescriptorIntPair, ExtensionInfo >	mutableExtensionsByNumber

Detailed Description

A table of known extensions, searchable by name or field number. When parsing a protocol message that might have extensions, you must provide an

ExtensionRegistry

in which you have registered any extensions that you want to be able to parse. Otherwise, those extensions will just be treated like unknown fields.

For example, if you had the

.proto

file:

option java_class = "MyProto";

message Foo {
  extensions 1000 to max;
}

extend Foo {
  optional int32 bar;
}

Then you might write code like:

ExtensionRegistry registry = ExtensionRegistry.newInstance();
registry.add(MyProto.bar);
MyProto.Foo message = MyProto.Foo.parseFrom(input, registry);

Background:

You might wonder why this is necessary. Two alternatives might come to mind. First, you might imagine a system where generated extensions are automatically registered when their containing classes are loaded. This is a popular technique, but is bad design; among other things, it creates a situation where behavior can change depending on what classes happen to be loaded. It also introduces a security vulnerability, because an unprivileged class could cause its code to be called unexpectedly from a privileged class by registering itself as an extension of the right type.

Another option you might consider is lazy parsing: do not parse an extension until it is first requested, at which point the caller must provide a type to use. This introduces a different set of problems. First, it would require a mutex lock any time an extension was accessed, which would be slow. Second, corrupt data would not be detected until first access, at which point it would be much harder to deal with it. Third, it could violate the expectation that message objects are immutable, since the type provided could be any arbitrary message class. An unprivileged user could take advantage of this to inject a mutable object into a message belonging to privileged code and create mischief.

Author: kento.nosp@m.n@go.nosp@m.ogle..nosp@m.com Kenton Varda

Definition at line 91 of file ExtensionRegistry.java.

Constructor & Destructor Documentation

◆ ExtensionRegistry() [1/2]

com.google.protobuf.ExtensionRegistry.ExtensionRegistry ( )

inlineprivate

Definition at line 270 of file ExtensionRegistry.java.

◆ ExtensionRegistry() [2/2]

com.google.protobuf.ExtensionRegistry.ExtensionRegistry ( ExtensionRegistry other )

inlineprivate

Definition at line 277 of file ExtensionRegistry.java.

Member Function Documentation

◆ add() [1/5]

void com.google.protobuf.ExtensionRegistry.add ( final Extension<?, ?> extension )

inline

Add an extension from a generated file to the registry.

Definition at line 218 of file ExtensionRegistry.java.

◆ add() [2/5]

void com.google.protobuf.ExtensionRegistry.add	(	final ExtensionInfo	extension,
		final Extension.ExtensionType	extensionType
	)

inlineprivate

Definition at line 301 of file ExtensionRegistry.java.

◆ add() [3/5]

void com.google.protobuf.ExtensionRegistry.add ( final FieldDescriptor type )

inline

Add a non-message-type extension to the registry by descriptor.

Definition at line 247 of file ExtensionRegistry.java.

◆ add() [4/5]

void com.google.protobuf.ExtensionRegistry.add	(	final FieldDescriptor	type,
		final Message	defaultInstance
	)

inline

Add a message-type extension to the registry by descriptor.

Definition at line 259 of file ExtensionRegistry.java.

◆ add() [5/5]

void com.google.protobuf.ExtensionRegistry.add ( final GeneratedMessage.GeneratedExtension<?, ?> extension )

inline

Add an extension from a generated file to the registry.

Definition at line 228 of file ExtensionRegistry.java.

◆ findExtensionByName()

ExtensionInfo com.google.protobuf.ExtensionRegistry.findExtensionByName ( final String fullName )

inline

Deprecated. Use findImmutableExtensionByName(String) instead.

Definition at line 133 of file ExtensionRegistry.java.

◆ findExtensionByNumber()

ExtensionInfo com.google.protobuf.ExtensionRegistry.findExtensionByNumber	(	final Descriptor	containingType,
		final int	fieldNumber
	)

inline

Deprecated. Use findImmutableExtensionByNumber( Descriptors.Descriptor, int)

Definition at line 159 of file ExtensionRegistry.java.

◆ findImmutableExtensionByName()

ExtensionInfo com.google.protobuf.ExtensionRegistry.findImmutableExtensionByName ( final String fullName )

inline

Find an extension for immutable APIs by fully-qualified field name, in the proto namespace. i.e.

result.descriptor.fullName()

will match

fullName

if a match is found.

Returns: Information about the extension if found, or
null

otherwise.

Definition at line 143 of file ExtensionRegistry.java.

◆ findImmutableExtensionByNumber()

ExtensionInfo com.google.protobuf.ExtensionRegistry.findImmutableExtensionByNumber	(	final Descriptor	containingType,
		final int	fieldNumber
	)

inline

Find an extension by containing type and field number for immutable APIs.

Returns: Information about the extension if found, or
null

otherwise.

Definition at line 169 of file ExtensionRegistry.java.

◆ findMutableExtensionByName()

ExtensionInfo com.google.protobuf.ExtensionRegistry.findMutableExtensionByName ( final String fullName )

inline

Find an extension for mutable APIs by fully-qualified field name, in the proto namespace. i.e.

result.descriptor.fullName()

will match

fullName

if a match is found.

Returns: Information about the extension if found, or
null

otherwise.

Definition at line 153 of file ExtensionRegistry.java.

◆ findMutableExtensionByNumber()

ExtensionInfo com.google.protobuf.ExtensionRegistry.findMutableExtensionByNumber	(	final Descriptor	containingType,
		final int	fieldNumber
	)

inline

Find an extension by containing type and field number for mutable APIs.

Returns: Information about the extension if found, or
null

otherwise.

Definition at line 179 of file ExtensionRegistry.java.

◆ getAllImmutableExtensionsByExtendedType()

Set<ExtensionInfo> com.google.protobuf.ExtensionRegistry.getAllImmutableExtensionsByExtendedType ( final String fullName )

inline

Find all extensions for immutable APIs by fully-qualified name of extended class. Note that this method is more computationally expensive than getting a single extension by name or number.

Returns: Information about the extensions found, or
null

if there are none.

Definition at line 207 of file ExtensionRegistry.java.

◆ getAllMutableExtensionsByExtendedType()

Set<ExtensionInfo> com.google.protobuf.ExtensionRegistry.getAllMutableExtensionsByExtendedType ( final String fullName )

inline

Find all extensions for mutable APIs by fully-qualified name of extended class. Note that this method is more computationally expensive than getting a single extension by name or number.

Returns: Information about the extensions found, or
null

if there are none.

Definition at line 190 of file ExtensionRegistry.java.

◆ getEmptyRegistry()

static ExtensionRegistry com.google.protobuf.ExtensionRegistry.getEmptyRegistry ( )

inlinestatic

Get the unmodifiable singleton empty instance.

Reimplemented from com.google.protobuf.ExtensionRegistryLite.

Definition at line 98 of file ExtensionRegistry.java.

◆ getUnmodifiable()

ExtensionRegistry com.google.protobuf.ExtensionRegistry.getUnmodifiable ( )

inline

Returns an unmodifiable view of the registry.

Reimplemented from com.google.protobuf.ExtensionRegistryLite.

Definition at line 105 of file ExtensionRegistry.java.

◆ newInstance()

static ExtensionRegistry com.google.protobuf.ExtensionRegistry.newInstance ( )

inlinestatic

Construct a new, empty instance.

Reimplemented from com.google.protobuf.ExtensionRegistryLite.

Definition at line 93 of file ExtensionRegistry.java.

Member Data Documentation

◆ immutableExtensionsByName

final Map<String, ExtensionInfo> com.google.protobuf.ExtensionRegistry.immutableExtensionsByName

private

Definition at line 286 of file ExtensionRegistry.java.

◆ immutableExtensionsByNumber

final Map<DescriptorIntPair, ExtensionInfo> com.google.protobuf.ExtensionRegistry.immutableExtensionsByNumber

private

Definition at line 288 of file ExtensionRegistry.java.

◆ mutableExtensionsByName

final Map<String, ExtensionInfo> com.google.protobuf.ExtensionRegistry.mutableExtensionsByName

private

Definition at line 287 of file ExtensionRegistry.java.

◆ mutableExtensionsByNumber

final Map<DescriptorIntPair, ExtensionInfo> com.google.protobuf.ExtensionRegistry.mutableExtensionsByNumber

private

Definition at line 289 of file ExtensionRegistry.java.

The documentation for this class was generated from the following file:

ExtensionRegistry.java

Classes

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ExtensionRegistry() [1/2]

◆ ExtensionRegistry() [2/2]

Member Function Documentation

◆ add() [1/5]

◆ add() [2/5]

◆ add() [3/5]

◆ add() [4/5]

◆ add() [5/5]

◆ findExtensionByName()

◆ findExtensionByNumber()

◆ findImmutableExtensionByName()

◆ findImmutableExtensionByNumber()

◆ findMutableExtensionByName()

◆ findMutableExtensionByNumber()

◆ getAllImmutableExtensionsByExtendedType()

◆ getAllMutableExtensionsByExtendedType()

◆ getEmptyRegistry()

◆ getUnmodifiable()

◆ newInstance()

Member Data Documentation

◆ immutableExtensionsByName

◆ immutableExtensionsByNumber

◆ mutableExtensionsByName

◆ mutableExtensionsByNumber