Class FileDescriptor

java.lang.Object

org.infinispan.protostream.descriptors.FileDescriptor

public final class FileDescriptor
extends Object

Representation of a .proto file, including its dependencies.

Since:

2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	FileDescriptor.Builder
private static enum	FileDescriptor.Status	The validation status of a .proto file.
static enum	FileDescriptor.Syntax

Field Summary

Fields

Modifier and Type	Field	Description
private Configuration	configuration
private final Map<String, FileDescriptor>	dependants	Files that directly depend on this one.
private final List<String>	dependencies	The imports.
private final List<EnumDescriptor>	enumTypes
private FileNamespace	fileNamespace	The types defined in this file or in the imported files.
private static final Log	log
private final List<Descriptor>	messageTypes
private final String	name
private final List<Option>	options
private final String	packageName
private final DescriptorParserException	parsingException	When status is equal to FileDescriptor.Status.PARSING_ERROR, this exception provides the cause.
private final List<String>	publicDependencies	The public imports.
private FileDescriptor.Status	status
private final FileDescriptor.Syntax	syntax

Constructor Summary

Constructors

Modifier	Constructor	Description
private	FileDescriptor(FileDescriptor.Builder builder)

Method Summary

Modifier and Type	Method	Description
void	checkCompatibility(FileDescriptor that, boolean strict)
void	checkCompatibility(FileDescriptor that, boolean strict, List<String> errors)
void	clearErrors()	Clear resolving errors of unresolved files.
private void	collectDescriptors(Descriptor descriptor, ResolutionContext resolutionContext)
private void	collectEnumDescriptors(EnumDescriptor enumDescriptor, ResolutionContext resolutionContext)
static String	fullName(String parent, String name)
Configuration	getConfiguration()
Map<String, FileDescriptor>	getDependants()
Collection<String>	getDependencies()
List<EnumDescriptor>	getEnumTypes()
Namespace	getExportedNamespace()
List<Descriptor>	getMessageTypes()	Top level message types defined in this file.
String	getName()
Option	getOption(String name)
List<Option>	getOptions()
String	getPackage()
private String	getScopedName(String name)
FileDescriptor.Syntax	getSyntax()
Map<String, GenericDescriptor>	getTypes()	All types defined in this file (both message and enum).
boolean	isResolved()
(package private) void	markError()
void	markUnresolved()
void	parseAnnotations()
void	resolveDependencies(ResolutionContext resolutionContext)	Resolve type references across files and report semantic errors like duplicate type declarations, duplicate type ids or clashing enum value constants.
private void	resolveDependencies(ResolutionContext resolutionContext, Set<String> processedFiles)
private void	resolveFieldTypes(Descriptor descriptor)
private List<FileDescriptor>	resolveImports(List<String> dependencies, ResolutionContext resolutionContext, Set<String> processedFiles)	Resolves imported file names to FileDescriptors.
private GenericDescriptor	searchType(String name, Descriptor scope)
void	setConfiguration(Configuration configuration)	This method is not part of the public API.
String	toString()

Methods inherited from class Object

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

Field Details

log

private static final Log log

syntax

private final FileDescriptor.Syntax syntax

configuration

private Configuration configuration

name

private final String name

packageName

private final String packageName

dependencies

private final List<String> dependencies

The imports. These are not transitive.

publicDependencies

private final List<String> publicDependencies

The public imports. These generate transitive dependencies.

options

private final List<Option> options

messageTypes

private final List<Descriptor> messageTypes

enumTypes

private final List<EnumDescriptor> enumTypes

dependants

private final Map<String, FileDescriptor> dependants

Files that directly depend on this one.

fileNamespace

private FileNamespace fileNamespace

The types defined in this file or in the imported files.

status

private FileDescriptor.Status status

parsingException

private final DescriptorParserException parsingException

When status is equal to FileDescriptor.Status.PARSING_ERROR, this exception provides the cause.

Constructor Details

FileDescriptor

private FileDescriptor(FileDescriptor.Builder builder)

Method Details

getConfiguration

public Configuration getConfiguration()

setConfiguration

public void setConfiguration(Configuration configuration)

This method is not part of the public API. May be removed in future versions.

getDependants

public Map<String, FileDescriptor> getDependants()

getDependencies

public Collection<String> getDependencies()

isResolved

public boolean isResolved()

markUnresolved

public void markUnresolved()

markError

void markError()

clearErrors

public void clearErrors()

Clear resolving errors of unresolved files. Parsing errors are not cleared. Transitions from ERROR status back to UNRESOLVED and propagates this recursively to all dependant FileDescriptors. All internal state acquired during type reference resolution is cleared for this file and dependants (recursively).

getExportedNamespace

public Namespace getExportedNamespace()

resolveDependencies

public void resolveDependencies(ResolutionContext resolutionContext)
                         throws DescriptorParserException

Resolve type references across files and report semantic errors like duplicate type declarations, duplicate type ids or clashing enum value constants. Only FileDescriptor.Status.UNRESOLVED files are processed. Files with other states are ignored.

Throws:

DescriptorParserException

resolveDependencies

private void resolveDependencies(ResolutionContext resolutionContext,
 Set<String> processedFiles)
                          throws DescriptorParserException

Throws:

DescriptorParserException

resolveImports

private List<FileDescriptor> resolveImports(List<String> dependencies,
 ResolutionContext resolutionContext,
 Set<String> processedFiles)
                                     throws DescriptorParserException

Resolves imported file names to FileDescriptors. Changes the status of current file to ERROR if any of the imported files (directly or indirectly) have any errors.

Returns:

the list of resolved FileDescriptors

Throws:

DescriptorParserException

collectDescriptors

private void collectDescriptors(Descriptor descriptor,
 ResolutionContext resolutionContext)

collectEnumDescriptors

private void collectEnumDescriptors(EnumDescriptor enumDescriptor,
 ResolutionContext resolutionContext)

resolveFieldTypes

private void resolveFieldTypes(Descriptor descriptor)

getScopedName

private String getScopedName(String name)

searchType

private GenericDescriptor searchType(String name,
 Descriptor scope)

getSyntax

public FileDescriptor.Syntax getSyntax()

getName

public String getName()

getPackage

public String getPackage()

getOptions

public List<Option> getOptions()

getOption

public Option getOption(String name)

getEnumTypes

public List<EnumDescriptor> getEnumTypes()

getMessageTypes

public List<Descriptor> getMessageTypes()

Top level message types defined in this file.

getTypes

public Map<String, GenericDescriptor> getTypes()

All types defined in this file (both message and enum).

checkCompatibility

public void checkCompatibility(FileDescriptor that,
 boolean strict,
 List<String> errors)

checkCompatibility

public void checkCompatibility(FileDescriptor that,
 boolean strict)

parseAnnotations

public void parseAnnotations()

toString

public String toString()

Overrides:

toString in class Object

fullName

public static String fullName(String parent,
 String name)