Record Class FieldDefinition

java.lang.Object

java.lang.Record

express.mvp.myra.codec.schema.FieldDefinition

Record Components:

tag - the 1-based field tag used for ordering and compatibility

name - the field name

type - the field type name (primitive, enum, or message type)

optional - whether the field is optional

repeated - whether the field is a repeating group

deprecated - whether the field is deprecated

deprecationNote - human-friendly deprecation guidance

fixedCapacity - fixed inline capacity for string/bytes fields, or null when variable

public record FieldDefinition(int tag, String name, String type, boolean optional, boolean repeated, boolean deprecated, String deprecationNote, Integer fixedCapacity)
extends Record

Describes a single field in a message schema.

Constructor Summary

Constructors

Constructor	Description
FieldDefinition(int tag, String name, String type, boolean optional, boolean repeated, boolean deprecated, String deprecationNote, Integer fixedCapacity)	Creates an instance of a FieldDefinition record class.

Method Summary

Modifier and Type	Method	Description
boolean	deprecated()	Returns the value of the deprecated record component.
String	deprecationNote()	Returns the value of the deprecationNote record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Integer	fixedCapacity()	Returns the value of the fixedCapacity record component.
final int	hashCode()	Returns a hash code value for this object.
String	name()	Returns the value of the name record component.
boolean	optional()	Returns the value of the optional record component.
boolean	repeated()	Returns the value of the repeated record component.
int	tag()	Returns the value of the tag record component.
final String	toString()	Returns a string representation of this record class.
String	type()	Returns the value of the type record component.

Methods inherited from class Object

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

Constructor Details

FieldDefinition

public FieldDefinition(int tag,
 String name,
 String type,
 boolean optional,
 boolean repeated,
 boolean deprecated,
 String deprecationNote,
 Integer fixedCapacity)

Creates an instance of a FieldDefinition record class.

Parameters:

tag - the value for the tag record component

name - the value for the name record component

type - the value for the type record component

optional - the value for the optional record component

repeated - the value for the repeated record component

deprecated - the value for the deprecated record component

deprecationNote - the value for the deprecationNote record component

fixedCapacity - the value for the fixedCapacity record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

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

tag

public int tag()

Returns the value of the tag record component.

Returns:

the value of the tag record component

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

type

public String type()

Returns the value of the type record component.

Returns:

the value of the type record component

optional

public boolean optional()

Returns the value of the optional record component.

Returns:

the value of the optional record component

repeated

public boolean repeated()

Returns the value of the repeated record component.

Returns:

the value of the repeated record component

deprecated

public boolean deprecated()

Returns the value of the deprecated record component.

Returns:

the value of the deprecated record component

deprecationNote

public String deprecationNote()

Returns the value of the deprecationNote record component.

Returns:

the value of the deprecationNote record component

fixedCapacity

public Integer fixedCapacity()

Returns the value of the fixedCapacity record component.

Returns:

the value of the fixedCapacity record component