[JAVA-358] Enums are not serialized without transformation Created: 27/May/11  Updated: 25/Jun/13  Resolved: 27/May/11

Status: Closed
Project: Java Driver
Component/s: API
Affects Version/s: None
Fix Version/s: None

Type: Bug Priority: Major - P3
Reporter: Robert Stiller Assignee: Antoine Girbal
Resolution: Duplicate Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Duplicate
duplicates JAVA-268 Add support for Java enums Closed
duplicates JAVA-359 Support Java Locale Type Closed

 Description   

Enums cannot be serialized without transforming them.

I propose, that all java enums are serialized (and deserialized) using the name() method (or valueOf() method).

Example (using QueryDSL):

@Entity
public enum Type {
TYPE1, TYPE2
}

public class MyObject {

protected Type type;

public Type getType() {
}

public void setType(Type type)

{ this.type = type; }

}

Usage:

QMyObject.myObject.type.eq(Type.TYPE1); // ends in:

java.lang.IllegalArgumentException: can't serialize class Type
at org.bson.BSONEncoder._putObjectField(BSONEncoder.java:213)
at org.bson.BSONEncoder.putObject(BSONEncoder.java:123)
at org.bson.BSONEncoder._putObjectField(BSONEncoder.java:173)
at org.bson.BSONEncoder.putObject(BSONEncoder.java:123)
at org.bson.BSONEncoder.putObject(BSONEncoder.java:69)
at com.mongodb.OutMessage.putObject(OutMessage.java:189)
at com.mongodb.OutMessage._appendQuery(OutMessage.java:62)
at com.mongodb.OutMessage.query(OutMessage.java:39)
at com.mongodb.DBApiLayer$MyCollection.__find(DBApiLayer.java:293)
at com.mongodb.DB.command(DB.java:152)
at com.mongodb.DBCollection.getCount(DBCollection.java:760)
at com.mongodb.DBCollection.getCount(DBCollection.java:731)
at com.mongodb.DBCollection.count(DBCollection.java:697)
at com.mysema.query.mongodb.MongodbQuery.count(MongodbQuery.java:184)
at org.springframework.data.document.mongodb.repository.QueryDslMongoRepository.count(QueryDslMongoRepository.java:151)
at sun.reflect.GeneratedMethodAccessor9.invoke(Unknown Source)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
at java.lang.reflect.Method.invoke(Method.java:616)
at org.springframework.data.repository.support.RepositoryFactorySupport$QueryExecuterMethodInterceptor.executeMethodOn(RepositoryFactorySupport.java:356)
at org.springframework.data.repository.support.RepositoryFactorySupport$QueryExecuterMethodInterceptor.invoke(RepositoryFactorySupport.java:337)
at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed(ReflectiveMethodInvocation.java:172)
at org.springframework.aop.framework.JdkDynamicAopProxy.invoke(JdkDynamicAopProxy.java:202)
at $Proxy18.count(Unknown Source)



 Comments   
Comment by Robert Stiller [ 27/May/11 ]

Same goes for java.util.Locale - it is one of the essential Types in Java!

I propose the Serialization as follow:

myLocale.toString();

and the Deserialization:

Copied from org.springframework.util.StringUtils.parseLocaleString(String):

String[] parts = tokenizeToStringArray(localeString, "_ ", false, false);
String language = (parts.length > 0 ? parts[0] : "");
String country = (parts.length > 1 ? parts[1] : "");
String variant = "";
if (parts.length >= 2) {
// There is definitely a variant, and it is everything after the country
// code sans the separator between the country code and the variant.
int endIndexOfCountryCode = localeString.indexOf(country) + country.length();
// Strip off any leading '_' and whitespace, what's left is the variant.
variant = trimLeadingWhitespace(localeString.substring(endIndexOfCountryCode));
if (variant.startsWith("_"))

{ variant = trimLeadingCharacter(variant, '_'); }

}
return (language.length() > 0 ? new Locale(language, country, variant) : null);

Generated at Thu Feb 08 08:52:05 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.