Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Copyright 2016-2020 chronicle.software
*
* https://chronicle.software
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.openhft.chronicle.wire;
import net.openhft.chronicle.wire.internal.VanillaFieldInfo;
import net.openhft.chronicle.wire.internal.fieldinfo.*;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.stream.Collectors;
import static net.openhft.chronicle.wire.WireMarshaller.WIRE_MARSHALLER_CL;
/**
* 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.
*/
public interface FieldInfo {
static FieldInfo createForField(String name, Class type, BracketType bracketType, @NotNull Field field) {
// Choose the FieldInfo type based on the field's type.
if (!type.isPrimitive()) {
return new ObjectFieldInfo(name, type, bracketType, field);
} else if (type == int.class) {
return new IntFieldInfo(name, type, bracketType, field);
} else if (type == double.class) {
return new DoubleFieldInfo(name, type, bracketType, field);
} else if (type == long.class) {
return new LongFieldInfo(name, type, bracketType, field);
} else if (type == char.class) {
return new CharFieldInfo(name, type, bracketType, field);
}
// Default case for other primitive types.
return new VanillaFieldInfo(name, type, bracketType, field);
}
/**
* Looks up the meta-information of the fields associated with the provided class and returns
* a pair of information encapsulated in {@link Wires.FieldInfoPair}.
*
* @param aClass The class for which field info needs to be retrieved.
* @return A {@link Wires.FieldInfoPair} representing the field information of the class.
*/
@NotNull
static Wires.FieldInfoPair lookupClass(@NotNull Class aClass) {
final SerializationStrategy ss = Wires.CLASS_STRATEGY.get(aClass);
switch (ss.bracketType()) {
case NONE:
case SEQ:
return Wires.FieldInfoPair.EMPTY;
case MAP:
break;
case HISTORY_MESSAGE:
throw new AssertionError();
default:
// assume it could be a map
break;
}
@NotNull List fields = new ArrayList<>();
final WireMarshaller marshaller = WIRE_MARSHALLER_CL.get(aClass);
// Process each field of the class to create its FieldInfo.
for (@NotNull WireMarshaller.FieldAccess fa : marshaller.fields) {
final String name = fa.field.getName();
final Class type = fa.field.getType();
final SerializationStrategy ss2 = Wires.CLASS_STRATEGY.get(type);
final BracketType bracketType = ss2.bracketType();
fields.add(createForField(name, type, bracketType, fa.field));
}
// Return a pair of unmodifiable list of fields and a map of field names to their FieldInfo.
return new Wires.FieldInfoPair(
Collections.unmodifiableList(fields),
fields.stream().collect(Collectors.toMap(FieldInfo::name, f -> f)));
}
/**
* Returns the name of the field represented by this {@code FieldInfo} object.
*
* @return the name of the field represented by this {@code FieldInfo} object.
*/
String name();
/**
* Returns a {@link Class} identifying the declared type of the field
* represented by this {@code FieldInfo} object.
*
* @return a {@link Class} identifying the declared type of the field
* represented by this {@code FieldInfo} object.
*/
Class type();
/**
* Returns the {@link BracketType} used by the serialization strategy associated
* with this {@code FieldInfo} object.
*
* @return the {@link BracketType} used by the serialization strategy associated
* with this {@code FieldInfo} object.
*/
BracketType bracketType();
/**
* Returns the value of the field represented by this {@code FieldInfo} object
* as an {@link Object}. The provided {@code object} is used as a target to
* extract the field from.
*
* @return the value of the field represented by this {@code FieldInfo} object
* as an {@link Object}.
*/
@Nullable
Object get(Object object);
/**
* Returns the value of the field represented by this {@code FieldInfo} object
* as a {@code long} primitive. The provided {@code object} is used as a target
* to extract the field from.
*
* @return the value of the field represented by this {@code FieldInfo} object
* as a {@code long} primitive.
*/
long getLong(Object object);
/**
* Returns the value of the field represented by this {@code FieldInfo} object
* as an {@code int} primitive. The provided {@code object} is used as a target
* to extract the field from.
*
* @return the value of the field represented by this {@code FieldInfo} object
* as an {@code int} primitive.
*/
int getInt(Object object);
/**
* Returns the value of the field represented by this {@code FieldInfo} object
* as a {@code char} primitive. The provided {@code object} is used as a target
* to extract the field from.
*
* @return the value of the field represented by this {@code FieldInfo} object
* as a {@code char} primitive.
*/
char getChar(Object object);
/**
* Returns the value of the field represented by this {@code FieldInfo} object
* as a {@code double} primitive. The provided {@code object} is used as a target
* to extract the field from.
*
* @return the value of the field represented by this {@code FieldInfo} object
* as a {@code double} primitive.
*/
double getDouble(Object object);
/**
* Sets the value of the field represented by this {@code FieldInfo} object
* to the provided {@code value}. The provided {@code object} is used as a
* target to the extract eh field from.
*/
void set(Object object, Object value) throws IllegalArgumentException;
/**
* Sets the value of the field represented by this {@code FieldInfo} object
* to the provided {@code value}. The provided {@code object} is used as a
* target to the extract eh field from.
*/
void set(Object object, char value) throws IllegalArgumentException;
/**
* Sets the value of the field represented by this {@code FieldInfo} object
* to the provided {@code value}. The provided {@code object} is used as a
* target to the extract eh field from.
*/
void set(Object object, int value) throws IllegalArgumentException;
/**
* Sets the value of the field represented by this {@code FieldInfo} object
* to the provided {@code value} of type {@code long}. The provided {@code object} is used as a
* target from which the field is extracted.
*
* @param object The object containing the field to be set.
* @param 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.
*/
void set(Object object, long value) throws IllegalArgumentException;
/**
* Sets the value of the field represented by this {@code FieldInfo} object
* to the provided {@code value} of type {@code double}. The provided {@code object} is used as a
* target from which the field is extracted.
*
* @param object The object containing the field to be set.
* @param 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.
*/
void set(Object object, double value) throws IllegalArgumentException;
/**
* Retrieves the {@link Class} identifying the declared generic type of the
* field represented by this {@code FieldInfo} object at the provided {@code index}.
*
* @param index The index of the generic type to be retrieved.
* @return a {@link Class} identifying the declared generic type of the field represented by
* this {@code FieldInfo} object at the provided {@code index}.
*/
Class genericType(int index);
/**
* Copies the value of the field represented by this {@code FieldInfo} object from
* the source object to the destination object. It's a shallow copy, so objects will be
* copied by reference.
*
* @param source The object from which the field value is to be copied.
* @param destination The object to which the field value is to be copied.
*/
default void copy(Object source, Object destination) {
set(destination, get(source));
}
/**
* Compares the value of the field represented by this {@code FieldInfo} in both provided
* objects {@code a} and {@code b} and determines if they are equal.
*
* @param a First object to compare the field's value.
* @param b Second object to compare the field's value.
* @return {@code true} if the values are equal, {@code false} otherwise.
*/
boolean isEqual(Object a, Object b);
}
