Sharmarke Aden created AVRO-1186:
------------------------------------
Summary: Java Annotations via IDL
Key: AVRO-1186
URL: https://issues.apache.org/jira/browse/AVRO-1186
Project: Avro
Issue Type: New Feature
Reporter: Sharmarke Aden
We would like to have the ability to add Java annotations to fields in the Avro
IDL (i.e. JSR 303 Bean Validation annotations). From a protocol stand point
these annotations may not mean much (or could they?) but from the application
stand point having this feature would allow developers to use Avro generated
beans application wide. From view layer all the way to the data layer. To
support this feature an IDL file could look something like this:
{code}
@namespace("test.annotations")
protocol TestProto {
record User {
//declare the annotations that are imported in the generated record class
@header{
import org.hibernate.validator.constraints.NotBlank;
import org.hibernate.validator.constraints.Email;
}
//for each field one can specify an annotation they would like to use.
@{@NotBlank} string username;
string password;
@{@Email} string email;
}
}
{code}
The above IDL would generate a Java class that looks something like this:
{code}
/**
* Autogenerated by Avro
*
* DO NOT EDIT DIRECTLY
*/
package com.simvia.mode.avro;
import org.hibernate.validator.constraints.NotBlank;
import org.hibernate.validator.constraints.Email;
@SuppressWarnings("all")
public class User extends org.apache.avro.specific.SpecificRecordBase
implements org.apache.avro.specific.SpecificRecord {
...
@Deprecated @NotBlank public java.lang.CharSequence username;
@Deprecated public java.lang.CharSequence password;
@Deprecated @Email public java.lang.CharSequence email;
...
}
{code}
Perhaps this is too language specific but IMO the benefits of this feature in
the Java world is worth the effort and the exception.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
