net.openhft.chronicle.wire

Interface FieldInfo

All Known Implementing Classes:

AbstractFieldInfo

public interface FieldInfo

Represents an abstraction for the meta-information of a field within a class or interface. Implementations should provide more specific details about the type, nature, and characteristics of the field.

Method Summary

Modifier and Type	Method and Description
BracketType	bracketType() Returns the BracketType used by the serialization strategy associated with this FieldInfo object.
default void	copy(Object source, Object destination) Copies the value of the field represented by this FieldInfo object from the source object to the destination object.
static FieldInfo	createForField(String name, Class<?> type, BracketType bracketType, @NotNull Field field)
Class<?>	genericType(int index) Retrieves the Class identifying the declared generic type of the field represented by this FieldInfo object at the provided index.
@Nullable Object	get(Object object) Returns the value of the field represented by this FieldInfo object as an Object.
char	getChar(Object object) Returns the value of the field represented by this FieldInfo object as a char primitive.
double	getDouble(Object object) Returns the value of the field represented by this FieldInfo object as a double primitive.
int	getInt(Object object) Returns the value of the field represented by this FieldInfo object as an int primitive.
long	getLong(Object object) Returns the value of the field represented by this FieldInfo object as a long primitive.
boolean	isEqual(Object a, Object b) Compares the value of the field represented by this FieldInfo in both provided objects a and b and determines if they are equal.
static net.openhft.chronicle.wire.Wires.FieldInfoPair	lookupClass(@NotNull Class<?> aClass) Looks up the meta-information of the fields associated with the provided class and returns a pair of information encapsulated in Wires.FieldInfoPair.
String	name() Returns the name of the field represented by this FieldInfo object.
void	set(Object object, char value) Sets the value of the field represented by this FieldInfo object to the provided value.
void	set(Object object, double value) Sets the value of the field represented by this FieldInfo object to the provided value of type double.
void	set(Object object, int value) Sets the value of the field represented by this FieldInfo object to the provided value.
void	set(Object object, long value) Sets the value of the field represented by this FieldInfo object to the provided value of type long.
void	set(Object object, Object value) Sets the value of the field represented by this FieldInfo object to the provided value.
Class<?>	type() Returns a Class identifying the declared type of the field represented by this FieldInfo object.

Method Detail

createForField

static FieldInfo createForField(String name,
                                Class<?> type,
                                BracketType bracketType,
                                @NotNull
                                @NotNull Field field)

lookupClass

@NotNull
static net.openhft.chronicle.wire.Wires.FieldInfoPair lookupClass(@NotNull
                                                                           @NotNull Class<?> aClass)

Looks up the meta-information of the fields associated with the provided class and returns a pair of information encapsulated in Wires.FieldInfoPair.

Parameters:

aClass - The class for which field info needs to be retrieved.

Returns:

A Wires.FieldInfoPair representing the field information of the class.

name

String name()

Returns the name of the field represented by this FieldInfo object.

Returns:

the name of the field represented by this FieldInfo object.

type

Class<?> type()

Returns a Class identifying the declared type of the field represented by this FieldInfo object.

Returns:

a Class identifying the declared type of the field represented by this FieldInfo object.

bracketType

BracketType bracketType()

Returns the BracketType used by the serialization strategy associated with this FieldInfo object.

Returns:

the BracketType used by the serialization strategy associated with this FieldInfo object.

get

@Nullable
@Nullable Object get(Object object)

Returns the value of the field represented by this FieldInfo object as an Object. The provided object is used as a target to extract the field from.

Returns:

the value of the field represented by this FieldInfo object as an Object.

getLong

long getLong(Object object)

Returns the value of the field represented by this FieldInfo object as a long primitive. The provided object is used as a target to extract the field from.

Returns:

the value of the field represented by this FieldInfo object as a long primitive.

getInt

int getInt(Object object)

Returns the value of the field represented by this FieldInfo object as an int primitive. The provided object is used as a target to extract the field from.

Returns:

the value of the field represented by this FieldInfo object as an int primitive.

getChar

char getChar(Object object)

Returns the value of the field represented by this FieldInfo object as a char primitive. The provided object is used as a target to extract the field from.

Returns:

the value of the field represented by this FieldInfo object as a char primitive.

getDouble

double getDouble(Object object)

Returns the value of the field represented by this FieldInfo object as a double primitive. The provided object is used as a target to extract the field from.

Returns:

the value of the field represented by this FieldInfo object as a double primitive.

set

void set(Object object,
         Object value)
  throws IllegalArgumentException

Sets the value of the field represented by this FieldInfo object to the provided value. The provided object is used as a target to the extract eh field from.

Throws:

IllegalArgumentException

set

void set(Object object,
         char value)
  throws IllegalArgumentException

Sets the value of the field represented by this FieldInfo object to the provided value. The provided object is used as a target to the extract eh field from.

Throws:

IllegalArgumentException

set

void set(Object object,
         int value)
  throws IllegalArgumentException

Sets the value of the field represented by this FieldInfo object to the provided value. The provided object is used as a target to the extract eh field from.

Throws:

IllegalArgumentException

set

void set(Object object,
         long value)
  throws IllegalArgumentException

Sets the value of the field represented by this FieldInfo object to the provided value of type long. The provided object is used as a target from which the field is extracted.

Parameters:

object - The object containing the field to be set.

value - The value to set the field to.

Throws:

IllegalArgumentException - if the specified object is not an instance of the class or interface declaring the underlying field, or if an unwrapping conversion fails.

set

void set(Object object,
         double value)
  throws IllegalArgumentException

Sets the value of the field represented by this FieldInfo object to the provided value of type double. The provided object is used as a target from which the field is extracted.

Parameters:

object - The object containing the field to be set.

value - The value to set the field to.

Throws:

IllegalArgumentException - if the specified object is not an instance of the class or interface declaring the underlying field, or if an unwrapping conversion fails.

genericType

Class<?> genericType(int index)

Retrieves the Class identifying the declared generic type of the field represented by this FieldInfo object at the provided index.

Parameters:

index - The index of the generic type to be retrieved.

Returns:

a Class identifying the declared generic type of the field represented by this FieldInfo object at the provided index.

copy

default void copy(Object source,
                  Object destination)

Copies the value of the field represented by this FieldInfo object from the source object to the destination object. It's a shallow copy, so objects will be copied by reference.

Parameters:

source - The object from which the field value is to be copied.

destination - The object to which the field value is to be copied.

isEqual

boolean isEqual(Object a,
                Object b)

Compares the value of the field represented by this FieldInfo in both provided objects a and b and determines if they are equal.

Parameters:

a - First object to compare the field's value.

b - Second object to compare the field's value.

Returns:

true if the values are equal, false otherwise.