Top Description Inners Methods
com.squareup.protoparser

public Interface DataType

Known Direct Implementers
com.squareup.protoparser.DataType.ScalarType, com.squareup.protoparser.DataType.MapType, com.squareup.protoparser.DataType.NamedType
Imports
java.util.Locale

Representation of a scalar, map, or named type. While this class is an interface, only the included implementations are supported.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
public static class
public static class
public static enum

Method Summary

Modifier and TypeMethod and Description
public DataType.Kind
kind()

The kind of this type (and therefore implementing class).

Method Detail

kindback to summary
public DataType.Kind kind()

The kind of this type (and therefore implementing class).

com.squareup.protoparser back to summary

public final Enum DataType.Kind

extends Enum<DataType.Kind>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final DataType.Kind
MAP

Type is a MapType.

public static final DataType.Kind
NAMED

Type is a NamedType.

public static final DataType.Kind
SCALAR

Type is a ScalarType.

Constructor Summary

AccessConstructor and Description
private
Kind()

Method Summary

Modifier and TypeMethod and Description
public static DataType.Kind
public static DataType.Kind[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

MAPback to summary
public static final DataType.Kind MAP

Type is a MapType.

NAMEDback to summary
public static final DataType.Kind NAMED

Type is a NamedType.

SCALARback to summary
public static final DataType.Kind SCALAR

Type is a ScalarType.

Constructor Detail

Kindback to summary
private Kind()

Method Detail

valueOfback to summary
public static DataType.Kind valueOf(String name)
valuesback to summary
public static DataType.Kind[] values()
com.squareup.protoparser back to summary

public final Class DataType.MapType

extends Object
implements DataType
Class Inheritance
All Implemented Interfaces
com.squareup.protoparser.DataType

Field Summary

Modifier and TypeField and Description
private final DataType
private final DataType

Constructor Summary

AccessConstructor and Description
private
MapType(DataType keyType, DataType valueType)

Method Summary

Modifier and TypeMethod and Description
public static DataType.MapType
create(DataType keyType, DataType valueType)

public boolean
equals(Object
the reference object with which to compare.
obj
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public DataType
public DataType.Kind
kind()

Implements com.squareup.protoparser.DataType.kind.

The kind of this type (and therefore implementing class).

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

public DataType
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

keyTypeback to summary
private final DataType keyType
valueTypeback to summary
private final DataType valueType

Constructor Detail

MapTypeback to summary
private MapType(DataType keyType, DataType valueType)

Method Detail

createback to summary
public static DataType.MapType create(DataType keyType, DataType valueType)
equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
keyTypeback to summary
public DataType keyType()
kindback to summary
public DataType.Kind kind()

Implements com.squareup.protoparser.DataType.kind.

Doc from com.squareup.protoparser.DataType.kind.

The kind of this type (and therefore implementing class).

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override
valueTypeback to summary
public DataType valueType()
com.squareup.protoparser back to summary

public final Class DataType.NamedType

extends Object
implements DataType
Class Inheritance
All Implemented Interfaces
com.squareup.protoparser.DataType

Field Summary

Modifier and TypeField and Description
private final String

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static DataType.NamedType
create(String name)

public boolean
equals(Object
the reference object with which to compare.
obj
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public DataType.Kind
kind()

Implements com.squareup.protoparser.DataType.kind.

The kind of this type (and therefore implementing class).

public String
name()

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

nameback to summary
private final String name

Constructor Detail

NamedTypeback to summary
private NamedType(String name)

Method Detail

createback to summary
public static DataType.NamedType create(String name)
equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
kindback to summary
public DataType.Kind kind()

Implements com.squareup.protoparser.DataType.kind.

Doc from com.squareup.protoparser.DataType.kind.

The kind of this type (and therefore implementing class).

Annotations
@Override
nameback to summary
public String name()
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override
com.squareup.protoparser back to summary

public final Enum DataType.ScalarType

extends Enum<DataType.ScalarType>
implements DataType
Class Inheritance
All Implemented Interfaces
com.squareup.protoparser.DataType

Field Summary

Modifier and TypeField and Description
public static final DataType.ScalarType
public static final DataType.ScalarType
public static final DataType.ScalarType
public static final DataType.ScalarType
public static final DataType.ScalarType
public static final DataType.ScalarType
public static final DataType.ScalarType
public static final DataType.ScalarType
public static final DataType.ScalarType
public static final DataType.ScalarType
public static final DataType.ScalarType
public static final DataType.ScalarType
public static final DataType.ScalarType
public static final DataType.ScalarType
public static final DataType.ScalarType
public static final DataType.ScalarType

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public DataType.Kind
kind()

Implements com.squareup.protoparser.DataType.kind.

The kind of this type (and therefore implementing class).

public String
toString()

Overrides java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration.

public static DataType.ScalarType
public static DataType.ScalarType[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinalvalueOf

Field Detail

ANYback to summary
public static final DataType.ScalarType ANY
BOOLback to summary
public static final DataType.ScalarType BOOL
BYTESback to summary
public static final DataType.ScalarType BYTES
DOUBLEback to summary
public static final DataType.ScalarType DOUBLE
FIXED32back to summary
public static final DataType.ScalarType FIXED32
FIXED64back to summary
public static final DataType.ScalarType FIXED64
FLOATback to summary
public static final DataType.ScalarType FLOAT
INT32back to summary
public static final DataType.ScalarType INT32
INT64back to summary
public static final DataType.ScalarType INT64
SFIXED32back to summary
public static final DataType.ScalarType SFIXED32
SFIXED64back to summary
public static final DataType.ScalarType SFIXED64
SINT32back to summary
public static final DataType.ScalarType SINT32
SINT64back to summary
public static final DataType.ScalarType SINT64
STRINGback to summary
public static final DataType.ScalarType STRING
UINT32back to summary
public static final DataType.ScalarType UINT32
UINT64back to summary
public static final DataType.ScalarType UINT64

Constructor Detail

ScalarTypeback to summary
private ScalarType()

Method Detail

kindback to summary
public DataType.Kind kind()

Implements com.squareup.protoparser.DataType.kind.

Doc from com.squareup.protoparser.DataType.kind.

The kind of this type (and therefore implementing class).

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Enum.toString.

Doc from java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists.

Returns:String

the name of this enum constant

Annotations
@Override
valueOfback to summary
public static DataType.ScalarType valueOf(String name)
valuesback to summary
public static DataType.ScalarType[] values()