io.protostuff.parser

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.

Author:

David Yu

Date created:

Dec 18, 2009

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Proto.Loader

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Annotation annotation) Adds the annoation.
void	addExtension(Extension extension)
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()
void	putExtraOption(String key, Object value)
void	putStandardOption(String key, Object value)
String	toString()

Methods inherited from class io.protostuff.parser.AnnotationContainer

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

Methods inherited from class java.lang.Object

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

Constructor Detail

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 Detail

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.

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)

getEnumGroupMap

public Map<String,EnumGroup> getEnumGroupMap()

getEnumGroups

public Collection<EnumGroup> getEnumGroups()

getEnumGroup

public EnumGroup getEnumGroup(String name)

getServiceMap

public Map<String,Service> getServiceMap()

getServices

public Collection<Service> getServices()

getService

public Service getService(String name)

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)

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

toString

public String toString()

Overrides:

toString in class Object