Byte Mapper

Provides a convenient serializer and deserializer of Java objects into a compact byte array.

How to use

Add dependency to your project:

implementation 'ru.ilug:byte-mapper:1.0.1'

Sample data class for mapping:

@ByteEntity(1)
public class User {

    @ByteProperty(1)
    private int id;

    @ByteProperty(2)
    private String firstName;

    @ByteProperty(3)
    private short age;

    @ByteProperty(4)
    private Address address;

    @ByteProperty(5)
    private Contact[] contacts;
    
    // Getters and Setters...
}

Mapping object:

// Create Byte Mapper Context
ByteMapperContext context = new ByteMapperContext();
mapper = context.getByteMapper();

// Write User object to ByteBuffer
ByteBuffer exampleBuffer = ByteBuffer.allocate(1024);
mapper.write(exampleBuffer, user);

buffer.flip();

// Read User object from ByteBuffer
user = mapper.read(exampleBuffer);

Processing Custom Values

To add your own value processing, create a class inherited from codec.ru.ilug.bmapper.ValueCodec:

public class FloatCodec implements ValueCodec {

    @Override
    public Class<?>[] getProvidedValueClass() {
        return new Class[]{Float.class, float.class};
    }

    @Override
    public Object read(ByteBuffer buffer, Class<?> clazz, ByteMapperContext context, ByteMapper mapper) {
        return buffer.getFloat();
    }

    @Override
    public void write(ByteBuffer buffer, ByteMapperContext context, ByteMapper mapper, Object value) {
        buffer.putFloat((Float) value);
    }
}

Then register it with the ByteMapperContext:

ByteMapperContext context = new ByteMapperContext();
context.registerValueCodec(new FloatCodec());

Important! Register ValueCodec before you start working with the context!

Annotations

ByteEntity

All classes marked with the @ByteEntity annotation can be serialized and deserialized using ByteMapper. Each entity must have a unique numeric identifier within the same context.

ByteParameter

Each field marked with the @ByteParameter annotation will be serialized and deserialized. Fields NOT marked with this annotation will be ignored. Each field must have a unique numeric identifier within the same entity.