Jackson 2.18.2 · com.fasterxml.jackson.dataformat.protobuf.schema.ProtobufField

Field Summary

Modifier and Type	Field and Description
public final boolean	deprecated
protected final EnumLookup	enumValues For fields of type `FieldType#ENUM`, mapping from names to ids.
public final int	id Numeric tag, unshifted
public final boolean	isObject
public final boolean	isStdEnum
protected ProtobufMessage	messageType For main type of `FieldType#MESSAGE`, reference to actual message type definition.
public final String	name Name of field in protoc definition
public ProtobufField	next Link to next field within message definition; used for efficient traversal.
public final boolean	packed
public final boolean	repeated
public final boolean	required
public final FieldType	type
public final int	typedTag Combination of numeric tag and 3-bit wire type.
public final boolean	usesZigZag
public final int	wireType 3-bit id used on determining details of how values are serialized.

Constructor Summary

Access	Constructor and Description
public	ProtobufField(FieldElement nativeField, FieldType type)
public	ProtobufField(FieldElement nativeField, ProtobufMessage msg)
public	ProtobufField(FieldElement nativeField, ProtobufEnum et)
protected	ProtobufField(FieldElement nativeField, FieldType type, ProtobufMessage msg, ProtobufEnum et)

Method Summary

Modifier and Type	Method and Description
private static boolean	_findBooleanOption(FieldElement f, String key)
public void	assignMessageType(ProtobufMessage msgType)
public void	assignNext(ProtobufField n)
public int	compareTo(ProtobufField the object to be compared. other) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
public final String	findEnumByIndex(int index)
public final int	findEnumIndex(SerializableString key)
public final int	findEnumIndex(String key)
public Collection<String>	getEnumValues()
public final ProtobufMessage	getMessageType()
public final boolean	isArray()
public final boolean	isValidFor(int typeTag)
public final ProtobufField	nextIf(String nameToMatch)
public final ProtobufField	nextOrThisIf(int idToMatch)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public static ProtobufField	unknownField()

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

Field Detail

deprecated	back to summary
public final boolean deprecated

enumValues	back to summary
protected final EnumLookup enumValues For fields of type `FieldType#ENUM`, mapping from names to ids.

id	back to summary
public final int id Numeric tag, unshifted

isObject	back to summary
public final boolean isObject

isStdEnum	back to summary
public final boolean isStdEnum

messageType	back to summary
protected ProtobufMessage messageType For main type of `FieldType#MESSAGE`, reference to actual message type definition.

name	back to summary
public final String name Name of field in protoc definition

next	back to summary
public ProtobufField next Link to next field within message definition; used for efficient traversal. Due to inverse construction order need to be assigned after construction; but functionally immutable.

packed	back to summary
public final boolean packed

repeated	back to summary
public final boolean repeated

required	back to summary
public final boolean required

type	back to summary
public final FieldType type

typedTag	back to summary
public final int typedTag Combination of numeric tag and 3-bit wire type.

usesZigZag	back to summary
public final boolean usesZigZag

wireType	back to summary
public final int wireType 3-bit id used on determining details of how values are serialized.

Constructor Detail

ProtobufField	back to summary
public ProtobufField(FieldElement nativeField, FieldType type)

ProtobufField	back to summary
public ProtobufField(FieldElement nativeField, ProtobufMessage msg)

ProtobufField	back to summary
public ProtobufField(FieldElement nativeField, ProtobufEnum et)

ProtobufField	back to summary
protected ProtobufField(FieldElement nativeField, FieldType type, ProtobufMessage msg, ProtobufEnum et)

Method Detail

_findBooleanOption	back to summary
private static boolean _findBooleanOption(FieldElement f, String key)

assignMessageType	back to summary
public void assignMessageType(ProtobufMessage msgType)

assignNext	back to summary
public void assignNext(ProtobufField n)

compareTo back to summary

compareTo	back to summary
public int compareTo(ProtobufField other) Implements java.lang.Comparable.compareTo. Doc from java.lang.Comparable.compareTo. Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure `signum(x.compareTo(y)) == -signum(y.compareTo(x))` for all `x` and `y`. (This implies that `x.compareTo(y)` must throw an exception if and only if `y.compareTo(x)` throws an exception.) The implementor must also ensure that the relation is transitive: `(x.compareTo(y) > 0 && y.compareTo(z) > 0)` implies `x.compareTo(z) > 0`. Finally, the implementor must ensure that `x.compareTo(y)==0` implies that `signum(x.compareTo(z)) == signum(y.compareTo(z))`, for all `z`. Parameters other:ProtobufField the object to be compared. Returns:int a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Annotations @Override

public int compareTo(ProtobufField other)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters

other:ProtobufField: the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations

@Override

findEnumByIndex	back to summary
public final String findEnumByIndex(int index)

findEnumIndex	back to summary
public final int findEnumIndex(SerializableString key)

findEnumIndex	back to summary
public final int findEnumIndex(String key)

getEnumValues	back to summary
public Collection<String> getEnumValues()

getMessageType	back to summary
public final ProtobufMessage getMessageType()

isArray	back to summary
public final boolean isArray()

isValidFor	back to summary
public final boolean isValidFor(int typeTag)

nextIf	back to summary
public final ProtobufField nextIf(String nameToMatch)

nextOrThisIf	back to summary
public final ProtobufField nextOrThisIf(int idToMatch)

toString back to summary

toString	back 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

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