Skip to content

allow on-the-fly migration of primitive vs. boxed fields #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
c247t wants to merge 2 commits into
base: master
Choose a base branch
from
Open

allow on-the-fly migration of primitive vs. boxed fields #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
177a988
TECH: allow on-the-fly migration of primitive vs. boxed fields
c247t Oct 1, 2024
014cf4a
TECH: allow migration to sparse boxed fields
c247t Oct 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
225 changes: 189 additions & 36 deletions dump/src/util/dump/ExternalizableBean.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,26 +225,31 @@ default void readExternal( ObjectInput in ) throws IOException, ClassNotFoundExc
j++;
}

FieldType ft;
FieldType inputFt, configuredFt;
FieldAccessor f = null;
Class defaultType = null;
externalize annotation = null;

if ( (fieldIndexes[j] & 0xff) == fieldIndex ) {
final FieldType fft = ft = fieldTypes[j];
final FieldType fft = configuredFt = inputFt = fieldTypes[j];
f = fieldAccessors[j];
defaultType = defaultTypes[j];
if ( fieldTypeId != ft._id ) {
if ( fieldTypeId == FieldType.EnumOld._id && ft._id == FieldType.Enum._id ) {
ft = FieldType.EnumOld;
} else if ( fieldTypeId == FieldType.EnumSetOld._id && ft._id == FieldType.EnumSet._id ) {
ft = FieldType.EnumSetOld;
} else if ( fieldTypeId == FieldType.SetOfStrings._id && ft._id == FieldType.Set._id ) {
ft = FieldType.SetOfStrings;
} else if ( fieldTypeId == FieldType.ListOfStrings._id && ft._id == FieldType.List._id ) {
ft = FieldType.ListOfStrings;
} else if ( fieldTypeId == FieldType.Set._id && ft._id == FieldType.SetOfStrings._id ) {
ft = FieldType.Set;
} else if ( fieldTypeId == FieldType.List._id && ft._id == FieldType.ListOfStrings._id ) {
ft = FieldType.List;
if ( fieldTypeId != inputFt._id ) {
if ( fieldTypeId == FieldType.EnumOld._id && inputFt._id == FieldType.Enum._id ) {
inputFt = FieldType.EnumOld;
} else if ( fieldTypeId == FieldType.EnumSetOld._id && inputFt._id == FieldType.EnumSet._id ) {
inputFt = FieldType.EnumSetOld;
} else if ( fieldTypeId == FieldType.SetOfStrings._id && inputFt._id == FieldType.Set._id ) {
inputFt = FieldType.SetOfStrings;
} else if ( fieldTypeId == FieldType.ListOfStrings._id && inputFt._id == FieldType.List._id ) {
inputFt = FieldType.ListOfStrings;
} else if ( fieldTypeId == FieldType.Set._id && inputFt._id == FieldType.SetOfStrings._id ) {
inputFt = FieldType.Set;
} else if ( fieldTypeId == FieldType.List._id && inputFt._id == FieldType.ListOfStrings._id ) {
inputFt = FieldType.List;
} else if ( isCompatible(FieldType.forId(fieldTypeId), fft) ) {
annotation = config._annotations[j];
inputFt = FieldType.forId(fieldTypeId);
} else if ( Boolean.TRUE.equals(CLASS_CHANGED_INCOMPATIBLY.computeIfAbsent(getClass(), clazz -> {
LoggerFactory.getLogger(clazz).error("The field type of index " + fieldIndex + //
" in " + clazz.getSimpleName() + //
Expand All @@ -255,78 +260,110 @@ default void readExternal( ObjectInput in ) throws IOException, ClassNotFoundExc
return Boolean.TRUE;
})) ) {
// read it without exception, but ignore the data
ft = FieldType.forId(fieldTypeId);
inputFt = FieldType.forId(fieldTypeId);
f = null;
}
}
} else { // unknown field
ft = FieldType.forId(fieldTypeId);
configuredFt = inputFt = FieldType.forId(fieldTypeId);
}

Objects.requireNonNull(ft, "Invalid field type " + (fieldTypeId & 0xff) + " for field index " + fieldIndex);
Objects.requireNonNull(inputFt, "Invalid field type " + (fieldTypeId & 0xff) + " for field index " + fieldIndex);

if ( ft.isLengthDynamic() ) {
if ( inputFt.isLengthDynamic() ) {
int len = in.readInt();
if ( f == null ) { // unknown field, skip it
skipFully(in, len);
continue;
}
}

switch ( ft ) {
switch ( inputFt ) {
case pInt: {
int d = in.readInt();
if ( f != null ) {
f.setInt(this, d);
switch ( configuredFt ) {
case pInt -> f.setInt(this, d);
case Integer -> f.set(this, annotation.sparseBoxed() && d == annotation.pIntNullValue() ? null : d);
default -> throw new IllegalStateException();
}
}
break;
}
case pBoolean: {
boolean d = in.readBoolean();
if ( f != null ) {
f.setBoolean(this, d);
switch ( configuredFt ) {
case pBoolean -> f.setBoolean(this, d);
case Boolean -> f.set(this, annotation.sparseBoxed() && d == annotation.pBooleanNullValue() ? null : d);
default -> throw new IllegalStateException();
}
}
break;
}
case pByte: {
byte d = in.readByte();
if ( f != null ) {
f.setByte(this, d);
switch ( configuredFt ) {
case pByte -> f.setByte(this, d);
case Byte -> f.set(this, annotation.sparseBoxed() && d == annotation.pByteNullValue() ? null : d);
default -> throw new IllegalStateException();
}
}
break;
}
case pChar: {
char d = in.readChar();
if ( f != null ) {
f.setChar(this, d);
switch ( configuredFt ) {
case pChar -> f.setChar(this, d);
case Character -> f.set(this, annotation.sparseBoxed() && d == annotation.pCharNullValue() ? null : d);
default -> throw new IllegalStateException();
}
}
break;
}
case pDouble: {
double d = in.readDouble();
if ( f != null ) {
f.setDouble(this, d);
switch ( configuredFt ) {
case pDouble -> f.setDouble(this, d);
case Double -> f.set(this, annotation.sparseBoxed() && d == annotation.pDoubleNullValue() ? null : d);
default -> throw new IllegalStateException();
}
}
break;
}
case pFloat: {
float d = in.readFloat();
if ( f != null ) {
f.setFloat(this, d);
switch ( configuredFt ) {
case pFloat -> f.setFloat(this, d);
case Float -> f.set(this, annotation.sparseBoxed() && d == annotation.pFloatNullValue() ? null : d);
default -> throw new IllegalStateException();
}
}
break;
}
case pLong: {
long d = in.readLong();
if ( f != null ) {
f.setLong(this, d);
switch ( configuredFt ) {
case pLong -> f.setLong(this, d);
case Long -> f.set(this, annotation.sparseBoxed() && d == annotation.pLongNullValue() ? null : d);
default -> throw new IllegalStateException();
}
}
break;
}
case pShort: {
short d = in.readShort();
if ( f != null ) {
f.setShort(this, d);
switch ( configuredFt ) {
case pShort -> f.setShort(this, d);
case Short -> f.set(this, annotation.sparseBoxed() && d == annotation.pShortNullValue() ? null : d);
default -> throw new IllegalStateException();
}
}
break;
}
Expand Down Expand Up @@ -365,56 +402,89 @@ default void readExternal( ObjectInput in ) throws IOException, ClassNotFoundExc
case Integer: {
Integer d = readInteger(in);
if ( f != null ) {
f.set(this, d);
switch ( configuredFt ) {
case pInt -> f.setInt(this, d == null ? annotation.pIntNullValue() : d);
case Integer -> f.set(this, d);
default -> throw new IllegalStateException();
}
}
break;
}
case Boolean: {
Boolean d = readBoolean(in);
if ( f != null ) {
f.set(this, d);
switch ( configuredFt ) {
case pBoolean -> //noinspection SimplifiableConditionalExpression
f.setBoolean(this, d == null ? annotation.pBooleanNullValue() : false);
case Boolean -> f.set(this, d);
default -> throw new IllegalStateException();
}
}
break;
}
case Byte: {
Byte d = readByte(in);
if ( f != null ) {
f.set(this, d);
switch ( configuredFt ) {
case pByte -> f.setByte(this, d == null ? annotation.pByteNullValue() : d);
case Byte -> f.set(this, d);
default -> throw new IllegalStateException();
}
}
break;
}
case Character: {
Character d = readCharacter(in);
if ( f != null ) {
f.set(this, d);
switch ( configuredFt ) {
case pChar -> f.setChar(this, d == null ? annotation.pCharNullValue() : d);
case Character -> f.set(this, d);
default -> throw new IllegalStateException();
}
}
break;
}
case Double: {
Double d = readDouble(in);
if ( f != null ) {
f.set(this, d);
switch ( configuredFt ) {
case pDouble -> f.setDouble(this, d == null ? annotation.pDoubleNullValue() : d);
case Double -> f.set(this, d);
default -> throw new IllegalStateException();
}
}
break;
}
case Float: {
Float d = readFloat(in);
if ( f != null ) {
f.set(this, d);
switch ( configuredFt ) {
case pFloat -> f.setFloat(this, d == null ? annotation.pFloatNullValue() : d);
case Float -> f.set(this, d);
default -> throw new IllegalStateException();
}
}
break;
}
case Long: {
Long d = readLong(in);
if ( f != null ) {
f.set(this, d);
switch ( configuredFt ) {
case pLong -> f.setLong(this, d == null ? annotation.pLongNullValue() : d);
case Long -> f.set(this, d);
default -> throw new IllegalStateException();
}
}
break;
}
case Short: {
Short d = readShort(in);
if ( f != null ) {
f.set(this, d);
switch ( configuredFt ) {
case pShort -> f.setShort(this, d == null ? annotation.pShortNullValue() : d);
case Short -> f.set(this, d);
default -> throw new IllegalStateException();
}
}
break;
}
Expand Down Expand Up @@ -1216,6 +1286,44 @@ default void writeExternal( ObjectOutput out ) throws IOException {
}
}

private boolean isCompatible( FieldType inputType, FieldType configuredType ) {
return switch ( inputType ) {
case Boolean, pBoolean -> switch ( configuredType ) {
case Boolean, pBoolean -> true;
default -> false;
};
case Character, pChar -> switch ( configuredType ) {
case Character, pChar -> true;
default -> false;
};
case Byte, pByte -> switch ( configuredType ) {
case Byte, pByte -> true;
default -> false;
};
case Short, pShort -> switch ( configuredType ) {
case Short, pShort -> true;
default -> false;
};
case Integer, pInt -> switch ( configuredType ) {
case Integer, pInt -> true;
default -> false;
};
case Long, pLong -> switch ( configuredType ) {
case Long, pLong -> true;
default -> false;
};
case Float, pFloat -> switch ( configuredType ) {
case Float, pFloat -> true;
default -> false;
};
case Double, pDouble -> switch ( configuredType ) {
case Double, pDouble -> true;
default -> false;
};
default -> false;
};
}

/**
* By adding this annotation to a class implementing ExternalizableBean, you can make certain, that the byte[]
* created by externalizing has a size where <code>size%sizeModulo==0</code>, i.e. it is divisible by
Expand Down Expand Up @@ -1275,6 +1383,51 @@ default void writeExternal( ObjectOutput out ) throws IOException {
*/
Class defaultType() default System.class; // System.class is just a placeholder for nothing, in order to make this argument optional

/**
* The value for primitive fields being migrated from boxed values, in case the latter reads null from the input.
*/
boolean pBooleanNullValue() default false;

/**
* The value for primitive fields being migrated from boxed values, in case the latter reads null from the input.
*/
byte pByteNullValue() default 0;

/**
* The value for primitive fields being migrated from boxed values, in case the latter reads null from the input.
*/
char pCharNullValue() default 0;

/**
* The value for primitive fields being migrated from boxed values, in case the latter reads null from the input.
*/
double pDoubleNullValue() default 0.0;

/**
* The value for primitive fields being migrated from boxed values, in case the latter reads null from the input.
*/
float pFloatNullValue() default 0.0f;

/**
* The value for primitive fields being migrated from boxed values, in case the latter reads null from the input.
*/
int pIntNullValue() default 0;

/**
* The value for primitive fields being migrated from boxed values, in case the latter reads null from the input.
*/
long pLongNullValue() default 0L;

/**
* The value for primitive fields being migrated from boxed values, in case the latter reads null from the input.
*/
short pShortNullValue() default 0;

/**
* Defines whether boxed fields are set to null whenever primitive input matches the pTypeNullValue
*/
boolean sparseBoxed() default true;

/**
* Aka index. Must be unique. Convention is to start from 1. To guarantee compatibility between revisions of a bean,
* you may never change the field type or any of the default*Types while reusing the same index specified with this parameter.
Expand Down
Loading