Class Proto

java.lang.Object

io.protostuff.parser.AnnotationContainer

io.protostuff.parser.Proto

All Implemented Interfaces:

HasAnnotations, HasOptions, HasProto

public class Proto
extends AnnotationContainer
implements HasOptions

Contains the metadata of parsed protos. Basically repesents the .proto file.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Proto.Loader

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final LinkedHashMap<String, EnumGroup>	enumGroups
(package private) final ArrayList<Extension>	extensions
(package private) final LinkedHashMap<String,Object>	extraOptions
(package private) final File	file
(package private) final LinkedHashMap<String, EnumGroup>	fullyQualifiedEnumGroups
(package private) final LinkedHashMap<String,Message>	fullyQualifiedMessages
(package private) final LinkedHashMap<String,Proto>	importedProtos
(package private) final Proto	importer
(package private) Mutable<String>	javaPackageName
(package private) final Proto.Loader	loader
(package private) final LinkedHashMap<String,Message>	messages
(package private) Mutable<String>	packageName
(package private) final ArrayList<ConfiguredReference>	references
(package private) int	refOffset
(package private) final LinkedHashMap<String,Service>	services
private String	sourcePath
(package private) final LinkedHashMap<String,Object>	standardOptions
(package private) final URL	url

Fields inherited from class AnnotationContainer

annotations, docs

Constructor Summary

Constructors

Constructor	Description
Proto()
Proto(Proto.Loader loader)
Proto(File file)
Proto(File file, Proto.Loader loader)
Proto(File file, Proto.Loader loader, Proto importer)
Proto(URL url, Proto.Loader loader, Proto importer)

Method Summary

Modifier and Type	Method	Description
void	add(Annotation annotation)	Adds the annoation.
(package private) void	addAnnotationsTo(EnumGroup target)
(package private) void	addAnnotationsTo(EnumGroup.Value target)
(package private) void	addAnnotationsTo(Extension target)
(package private) void	addAnnotationsTo(Field<?> target, String enclosingNamespace)
(package private) void	addAnnotationsTo(Message target)
(package private) void	addAnnotationsTo(Service target)
(package private) void	addAnnotationsTo(Service.RpcMethod target)
(package private) void	addEnumGroup(EnumGroup enumGroup)
void	addExtension(Extension extension)
(package private) void	addImportedProto(Proto proto)
(package private) void	addMessage(Message message)
(package private) void	addService(Service service)
(package private) EnumGroup	findEnumGroupReference(String fullRefName, String enclosingNamespace)
(package private) HasName	findFullyQualifiedObject(String fullyQualifiedName)	Returns a Message or EnumGroup given its fully qualified name
(package private) Message	findMessageReference(String fullRefName, String enclosingNamespace)
(package private) HasName	findReference(String fullRefName, String enclosingNamespace)	Given the name of a Message/EnumGroup reference and the namespace enclosing that reference (can be a full message name or package name), returns the referenced object if it exists.
EnumGroup	getEnumGroup(String name)
Map<String, EnumGroup>	getEnumGroupMap()
Collection<EnumGroup>	getEnumGroups()
ErrorMap	getError()
Collection<Extension>	getExtensions()
<V> V	getExtraOption(String key)
LinkedHashMap<String,Object>	getExtraOptions()
File	getFile()
Proto	getImportedProto(File file)
Proto	getImportedProto(String url)
Proto	getImportedProto(URL url)
Collection<Proto>	getImportedProtos()
String	getJavaPackageName()
Message	getMessage(String name)
Map<String,Message>	getMessageMap()
Collection<Message>	getMessages()
Mutable<String>	getMutableJavaPackageName()
Mutable<String>	getMutablePackageName()
LinkedHashMap<String,Object>	getO()
LinkedHashMap<String,Object>	getOptions()
String	getOriginalJavaPackageName()	Returns the java package name that was configured in the proto.
String	getOriginalPackageName()	Returns the package name that was configured in the proto.
String	getPackageName()
Proto	getProto()
Service	getService(String name)
Map<String,Service>	getServiceMap()
Collection<Service>	getServices()
String	getSourcePath()
Object	getStandardOption(String name)
LinkedHashMap<String,Object>	getStandardOptions()
(package private) void	importProto(String path)
(package private) void	postParse()
void	putExtraOption(String key, Object value)
void	putStandardOption(String key, Object value)
(package private) void	setPackageName(String packageName)
String	toString()

Methods inherited from class AnnotationContainer

addAnnotations, addDoc, err, getA, getAnnotation, getAnnotationMap, getAnnotations, getDocs, hasAnnotation, isEmptyA

Methods inherited from class Object

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

Field Details

file

final File file

url

final URL url

loader

final Proto.Loader loader

importer

final Proto importer

packageName

Mutable<String> packageName

javaPackageName

Mutable<String> javaPackageName

importedProtos

final LinkedHashMap<String,Proto> importedProtos

standardOptions

final LinkedHashMap<String,Object> standardOptions

extraOptions

final LinkedHashMap<String,Object> extraOptions

messages

final LinkedHashMap<String,Message> messages

enumGroups

final LinkedHashMap<String, EnumGroup> enumGroups

services

final LinkedHashMap<String,Service> services

extensions

final ArrayList<Extension> extensions

fullyQualifiedMessages

final LinkedHashMap<String,Message> fullyQualifiedMessages

fullyQualifiedEnumGroups

final LinkedHashMap<String, EnumGroup> fullyQualifiedEnumGroups

references

final ArrayList<ConfiguredReference> references

refOffset

int refOffset

sourcePath

private String sourcePath

Constructor Details

Proto

public Proto()

Proto

public Proto(File file)

Proto

public Proto(Proto.Loader loader)

Proto

public Proto(File file,
 Proto.Loader loader)

Proto

public Proto(File file,
 Proto.Loader loader,
 Proto importer)

Proto

public Proto(URL url,
 Proto.Loader loader,
 Proto importer)

Method Details

getProto

public Proto getProto()

Specified by:

getProto in interface HasProto

getError

public ErrorMap getError()

getFile

public File getFile()

getSourcePath

public String getSourcePath()

getMutablePackageName

public Mutable<String> getMutablePackageName()

getPackageName

public String getPackageName()

getOriginalPackageName

public String getOriginalPackageName()

Returns the package name that was configured in the proto. Note that getPackageName() will have the same value as this, if the compiler options did not have entries that override it.

getMutableJavaPackageName

public Mutable<String> getMutableJavaPackageName()

getJavaPackageName

public String getJavaPackageName()

getOriginalJavaPackageName

public String getOriginalJavaPackageName()

Returns the java package name that was configured in the proto. Note that getJavaPackageName() will have the same value as this, if the compiler options did not have entries that override it.

setPackageName

void setPackageName(String packageName)

getStandardOptions

public LinkedHashMap<String,Object> getStandardOptions()

getStandardOption

public Object getStandardOption(String name)

getExtraOptions

public LinkedHashMap<String,Object> getExtraOptions()

getO

public LinkedHashMap<String,Object> getO()

getOptions

public LinkedHashMap<String,Object> getOptions()

Specified by:

getOptions in interface HasOptions

putStandardOption

public void putStandardOption(String key,
 Object value)

Specified by:

putStandardOption in interface HasOptions

putExtraOption

public void putExtraOption(String key,
 Object value)

Specified by:

putExtraOption in interface HasOptions

getExtraOption

public <V> V getExtraOption(String key)

getMessageMap

public Map<String,Message> getMessageMap()

getMessages

public Collection<Message> getMessages()

getMessage

public Message getMessage(String name)

addMessage

void addMessage(Message message)

getEnumGroupMap

public Map<String, EnumGroup> getEnumGroupMap()

getEnumGroups

public Collection<EnumGroup> getEnumGroups()

getEnumGroup

public EnumGroup getEnumGroup(String name)

addEnumGroup

void addEnumGroup(EnumGroup enumGroup)

getServiceMap

public Map<String,Service> getServiceMap()

getServices

public Collection<Service> getServices()

getService

public Service getService(String name)

addService

void addService(Service service)

addExtension

public void addExtension(Extension extension)

getExtensions

public Collection<Extension> getExtensions()

getImportedProtos

public Collection<Proto> getImportedProtos()

getImportedProto

public Proto getImportedProto(File file)

getImportedProto

public Proto getImportedProto(URL url)

getImportedProto

public Proto getImportedProto(String url)

importProto

void importProto(String path)

addImportedProto

void addImportedProto(Proto proto)

postParse

void postParse()

add

public void add(Annotation annotation)

Description copied from interface: HasAnnotations

Adds the annoation.

Specified by:

add in interface HasAnnotations

Overrides:

add in class AnnotationContainer

addAnnotationsTo

void addAnnotationsTo(Message target)

addAnnotationsTo

void addAnnotationsTo(EnumGroup target)

addAnnotationsTo

void addAnnotationsTo(EnumGroup.Value target)

addAnnotationsTo

void addAnnotationsTo(Field<?> target,
 String enclosingNamespace)

addAnnotationsTo

void addAnnotationsTo(Service target)

addAnnotationsTo

void addAnnotationsTo(Service.RpcMethod target)

addAnnotationsTo

void addAnnotationsTo(Extension target)

findReference

HasName findReference(String fullRefName,
 String enclosingNamespace)

Given the name of a Message/EnumGroup reference and the namespace enclosing that reference (can be a full message name or package name), returns the referenced object if it exists.

Parameters:

fullRefName - The full name of the object as specified by the reference, including a package name if it was specified

fullEnclosingNamespace - The full enclosing namespace of the reference

Returns:

A Message or EnumGroup instance, or null

findMessageReference

Message findMessageReference(String fullRefName,
 String enclosingNamespace)

findEnumGroupReference

EnumGroup findEnumGroupReference(String fullRefName,
 String enclosingNamespace)

findFullyQualifiedObject

HasName findFullyQualifiedObject(String fullyQualifiedName)

Returns a Message or EnumGroup given its fully qualified name

Parameters:

fullyQualifiedName - The fully qualified name, without an initial dot ('.')

Returns:

The Message or EnumGroup instance if it is defined in this Proto or one of its imports.

toString

public String toString()

Overrides:

toString in class Object