com.squareup.wire

Class Extension<T extends ExtendableMessage<?>,E>

java.lang.Object

com.squareup.wire.Extension<T,E>

Type Parameters:

T - the type of message being extended

E - the (boxed) Java data type of the extension value

All Implemented Interfaces:

Comparable<Extension<?,?>>

public final class Extension<T extends ExtendableMessage<?>,E>
extends Object
implements Comparable<Extension<?,?>>

An extended attribute of on a protocol buffer message. Extensions are used to declare additional fields for a message beyond the message's original declaration. For example, this declaration defines two extended attributes for a MenuItem message:

   extend MenuItem {
     optional int32 calorie_count = 10001;
     optional int32 fat_grams = 10002;
   }
 

An extension instance is a key; it names the attribute. Use it to set a value on a message's builder, or to get the value on a message.

   MenuItem sandwich = new MenuItem.Builder()
       .setBread(Bread.SOURDOUGH)
       .setExtension(Ext_nutrition.calorie_count, 300)
       .setExtension(Ext_nutrition.fat_grams, 6)
       .build();
   int calorieCount = sandwich.getExtension(Ext_nutrition.calorie_count));
   int fatGrams = sandwich.getExtension(Ext_nutrition.fat_grams));
 

Application code shouldn't create extension instances directly; instead they should use the generated instances created with Ext_ prefixes. To serialize and deserialize extensions, specify all of your Ext_ classes when creating a Wire instance.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Extension.Builder<T extends ExtendableMessage<?>,E>

Method Summary

Methods

Modifier and Type	Method and Description
static <T extends ExtendableMessage<?>> Extension.Builder<T,Boolean>	boolExtending(Class<T> extendedType)
static <T extends ExtendableMessage<?>> Extension.Builder<T,ByteString>	bytesExtending(Class<T> extendedType)
int	compareTo(Extension<?,?> o) Orders Extensions in ascending tag order.
static <T extends ExtendableMessage<?>> Extension.Builder<T,Double>	doubleExtending(Class<T> extendedType)
static <T extends ExtendableMessage<?>,E extends Enum> Extension.Builder<T,E>	enumExtending(Class<E> enumType, Class<T> extendedType)
boolean	equals(Object other)
static <T extends ExtendableMessage<?>> Extension.Builder<T,Integer>	fixed32Extending(Class<T> extendedType)
static <T extends ExtendableMessage<?>> Extension.Builder<T,Long>	fixed64Extending(Class<T> extendedType)
static <T extends ExtendableMessage<?>> Extension.Builder<T,Float>	floatExtending(Class<T> extendedType)
Message.Datatype	getDatatype()
Class<? extends Enum>	getEnumType()
Class<T>	getExtendedType()
Message.Label	getLabel()
Class<? extends Message>	getMessageType()
String	getName()
int	getTag()
int	hashCode()
static <T extends ExtendableMessage<?>> Extension.Builder<T,Integer>	int32Extending(Class<T> extendedType)
static <T extends ExtendableMessage<?>> Extension.Builder<T,Long>	int64Extending(Class<T> extendedType)
static <T extends ExtendableMessage<?>,M extends Message> Extension.Builder<T,M>	messageExtending(Class<M> messageType, Class<T> extendedType)
static <T extends ExtendableMessage<?>> Extension.Builder<T,Integer>	sfixed32Extending(Class<T> extendedType)
static <T extends ExtendableMessage<?>> Extension.Builder<T,Long>	sfixed64Extending(Class<T> extendedType)
static <T extends ExtendableMessage<?>> Extension.Builder<T,Integer>	sint32Extending(Class<T> extendedType)
static <T extends ExtendableMessage<?>> Extension.Builder<T,Long>	sint64Extending(Class<T> extendedType)
static <T extends ExtendableMessage<?>> Extension.Builder<T,String>	stringExtending(Class<T> extendedType)
String	toString()
static <T extends ExtendableMessage<?>> Extension.Builder<T,Integer>	uint32Extending(Class<T> extendedType)
static <T extends ExtendableMessage<?>> Extension.Builder<T,Long>	uint64Extending(Class<T> extendedType)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

int32Extending

public static <T extends ExtendableMessage<?>> Extension.Builder<T,Integer> int32Extending(Class<T> extendedType)

sint32Extending

public static <T extends ExtendableMessage<?>> Extension.Builder<T,Integer> sint32Extending(Class<T> extendedType)

uint32Extending

public static <T extends ExtendableMessage<?>> Extension.Builder<T,Integer> uint32Extending(Class<T> extendedType)

fixed32Extending

public static <T extends ExtendableMessage<?>> Extension.Builder<T,Integer> fixed32Extending(Class<T> extendedType)

sfixed32Extending

public static <T extends ExtendableMessage<?>> Extension.Builder<T,Integer> sfixed32Extending(Class<T> extendedType)

int64Extending

public static <T extends ExtendableMessage<?>> Extension.Builder<T,Long> int64Extending(Class<T> extendedType)

sint64Extending

public static <T extends ExtendableMessage<?>> Extension.Builder<T,Long> sint64Extending(Class<T> extendedType)

uint64Extending

public static <T extends ExtendableMessage<?>> Extension.Builder<T,Long> uint64Extending(Class<T> extendedType)

fixed64Extending

public static <T extends ExtendableMessage<?>> Extension.Builder<T,Long> fixed64Extending(Class<T> extendedType)

sfixed64Extending

public static <T extends ExtendableMessage<?>> Extension.Builder<T,Long> sfixed64Extending(Class<T> extendedType)

boolExtending

public static <T extends ExtendableMessage<?>> Extension.Builder<T,Boolean> boolExtending(Class<T> extendedType)

stringExtending

public static <T extends ExtendableMessage<?>> Extension.Builder<T,String> stringExtending(Class<T> extendedType)

bytesExtending

public static <T extends ExtendableMessage<?>> Extension.Builder<T,ByteString> bytesExtending(Class<T> extendedType)

floatExtending

public static <T extends ExtendableMessage<?>> Extension.Builder<T,Float> floatExtending(Class<T> extendedType)

doubleExtending

public static <T extends ExtendableMessage<?>> Extension.Builder<T,Double> doubleExtending(Class<T> extendedType)

enumExtending

public static <T extends ExtendableMessage<?>,E extends Enum> Extension.Builder<T,E> enumExtending(Class<E> enumType,
                                                                                   Class<T> extendedType)

messageExtending

public static <T extends ExtendableMessage<?>,M extends Message> Extension.Builder<T,M> messageExtending(Class<M> messageType,
                                                                                         Class<T> extendedType)

compareTo

public int compareTo(Extension<?,?> o)

Orders Extensions in ascending tag order.

Specified by:

compareTo in interface Comparable<Extension<?,?>>

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getExtendedType

public Class<T> getExtendedType()

getMessageType

public Class<? extends Message> getMessageType()

getEnumType

public Class<? extends Enum> getEnumType()

getName

public String getName()

getTag

public int getTag()

getDatatype

public Message.Datatype getDatatype()

getLabel

public Message.Label getLabel()