Top Description Inners Fields Constructors Methods

com.squareup.protoparser

public abstract Class ProtoFile

Class Inheritance

extends Object

java.lang.Object
com.squareup.protoparser.ProtoFile

Annotations

@AutoValue

Imports

com.google.auto.value.AutoValue, com.squareup.protoparser.Utils.Nullable, java.util.ArrayList, .Collection, .List

A single .proto file.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	ProtoFile.Builder
public static enum	ProtoFile.Syntax Syntax version.

Field Summary

Modifier and Type	Field and Description
pack-priv static final int	MAX_TAG_VALUE
pack-priv static final int	MIN_TAG_VALUE
private static final int	RESERVED_TAG_VALUE_END
private static final int	RESERVED_TAG_VALUE_START

Constructor Summary

Access	Constructor and Description
pack-priv	ProtoFile()

Method Summary

Modifier and Type	Method and Description
public static ProtoFile.Builder	builder(String filePath)
public abstract List<String>	dependencies()
public abstract List<ExtendElement>	extendDeclarations()
public abstract String	filePath()
pack-priv static boolean	isValidTag(int value) True if the supplied value is in the valid tag range and not reserved.
public abstract List<OptionElement>	options()
public abstract String	packageName()
public abstract List<String>	publicDependencies()
public abstract List<ServiceElement>	services()
public abstract ProtoFile.Syntax	syntax()
public final String	toSchema()
public abstract List<TypeElement>	typeElements()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

MAX_TAG_VALUE	back to summary
pack-priv static final int MAX_TAG_VALUE

MIN_TAG_VALUE	back to summary
pack-priv static final int MIN_TAG_VALUE

RESERVED_TAG_VALUE_END	back to summary
private static final int RESERVED_TAG_VALUE_END

RESERVED_TAG_VALUE_START	back to summary
private static final int RESERVED_TAG_VALUE_START

Constructor Detail

ProtoFile	back to summary
pack-priv ProtoFile()

Method Detail

builder	back to summary
public static ProtoFile.Builder builder(String filePath)

dependencies	back to summary
public abstract List<String> dependencies()

extendDeclarations	back to summary
public abstract List<ExtendElement> extendDeclarations()

filePath	back to summary
public abstract String filePath()

isValidTag	back to summary
pack-priv static boolean isValidTag(int value) True if the supplied value is in the valid tag range and not reserved.

options	back to summary
public abstract List<OptionElement> options()

packageName	back to summary
public abstract String packageName() Annotations @Nullable

publicDependencies	back to summary
public abstract List<String> publicDependencies()

services	back to summary
public abstract List<ServiceElement> services()

syntax	back to summary
public abstract ProtoFile.Syntax syntax() Annotations @Nullable

toSchema	back to summary
public final String toSchema()

typeElements	back to summary
public abstract List<TypeElement> typeElements()

com.squareup.protoparser back to summary

public final Class ProtoFile.Builder

Class Inheritance

extends Object

java.lang.Object
com.squareup.protoparser.ProtoFile.Builder

Field Summary

Modifier and Type	Field and Description
private final List<String>	dependencies
private final List<ExtendElement>	extendDeclarations
private final String	filePath
private final List<OptionElement>	options
private String	packageName
private final List<String>	publicDependencies
private final List<ServiceElement>	services
private ProtoFile.Syntax	syntax
private final List<TypeElement>	types

Constructor Summary

Access	Constructor and Description
pack-priv	Builder(String filePath)

Method Summary

Modifier and Type	Method and Description
public ProtoFile.Builder	addDependencies(Collection<String> dependencies)
public ProtoFile.Builder	addDependency(String dependency)
public ProtoFile.Builder	addExtendDeclaration(ExtendElement extend)
public ProtoFile.Builder	addExtendDeclarations(Collection<ExtendElement> extendDeclarations)
public ProtoFile.Builder	addOption(OptionElement option)
public ProtoFile.Builder	addOptions(Collection<OptionElement> options)
public ProtoFile.Builder	addPublicDependencies(Collection<String> dependencies)
public ProtoFile.Builder	addPublicDependency(String dependency)
public ProtoFile.Builder	addService(ServiceElement service)
public ProtoFile.Builder	addServices(Collection<ServiceElement> services)
public ProtoFile.Builder	addType(TypeElement type)
public ProtoFile.Builder	addTypes(Collection<TypeElement> types)
public ProtoFile	build()
public ProtoFile.Builder	packageName(String packageName)
public ProtoFile.Builder	syntax(ProtoFile.Syntax syntax)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

dependencies	back to summary
private final List<String> dependencies

extendDeclarations	back to summary
private final List<ExtendElement> extendDeclarations

filePath	back to summary
private final String filePath

options	back to summary
private final List<OptionElement> options

packageName	back to summary
private String packageName

publicDependencies	back to summary
private final List<String> publicDependencies

services	back to summary
private final List<ServiceElement> services

syntax	back to summary
private ProtoFile.Syntax syntax

types	back to summary
private final List<TypeElement> types

Constructor Detail

Builder	back to summary
pack-priv Builder(String filePath)

Method Detail

addDependencies	back to summary
public ProtoFile.Builder addDependencies(Collection<String> dependencies)

addDependency	back to summary
public ProtoFile.Builder addDependency(String dependency)

addExtendDeclaration	back to summary
public ProtoFile.Builder addExtendDeclaration(ExtendElement extend)

addExtendDeclarations	back to summary
public ProtoFile.Builder addExtendDeclarations(Collection<ExtendElement> extendDeclarations)

addOption	back to summary
public ProtoFile.Builder addOption(OptionElement option)

addOptions	back to summary
public ProtoFile.Builder addOptions(Collection<OptionElement> options)

addPublicDependencies	back to summary
public ProtoFile.Builder addPublicDependencies(Collection<String> dependencies)

addPublicDependency	back to summary
public ProtoFile.Builder addPublicDependency(String dependency)

addService	back to summary
public ProtoFile.Builder addService(ServiceElement service)

addServices	back to summary
public ProtoFile.Builder addServices(Collection<ServiceElement> services)

addType	back to summary
public ProtoFile.Builder addType(TypeElement type)

addTypes	back to summary
public ProtoFile.Builder addTypes(Collection<TypeElement> types)

build	back to summary
public ProtoFile build()

packageName	back to summary
public ProtoFile.Builder packageName(String packageName)

syntax	back to summary
public ProtoFile.Builder syntax(ProtoFile.Syntax syntax)

com.squareup.protoparser back to summary

public final Enum ProtoFile.Syntax

Class Inheritance

extends Enum<ProtoFile.Syntax>

java.lang.Object
java.lang.Enum
com.squareup.protoparser.ProtoFile.Syntax

Syntax version.

Field Summary

Modifier and Type	Field and Description
private final String	name Hides java.lang.Enum.name.
public static final ProtoFile.Syntax	PROTO_2
public static final ProtoFile.Syntax	PROTO_3

Constructor Summary

Access	Constructor and Description
private	Syntax(String name)

Method Summary

Modifier and Type	Method and Description
public static ProtoFile.Syntax	valueOf(String name)
public static ProtoFile.Syntax[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

name	back to summary
private final String name Hides java.lang.Enum.name.

PROTO_2	back to summary
public static final ProtoFile.Syntax PROTO_2

PROTO_3	back to summary
public static final ProtoFile.Syntax PROTO_3

Constructor Detail

Syntax	back to summary
private Syntax(String name)

Method Detail

valueOf	back to summary
public static ProtoFile.Syntax valueOf(String name)

values	back to summary
public static ProtoFile.Syntax[] values()