com.fortyoneconcepts.valjogen.annotations

Annotation Type VALJOGenerate

@Retention(value=SOURCE)
 @Target(value=TYPE)
public @interface VALJOGenerate

Use this annotation on Java interface to request a Value Object Class to be generated that implements the interface. See also VALJOConfigure for how to configure the details of the generated class.

Usage example (SimpleInterface.java):

 
 import com.fortyoneconcepts.valjogen.annotations.VALJOGenerate;

 @VALJOGenerate("MySimpleImpl")
 public interface SimpleInterface
 {
    public Object getObjectValue();
    public String getStringValue();
 }
 
 

The above code will instruct the VALJOGen annotation processor to generate a value object class called MySimpleImpl with members objectValue (of type Object) and stringValue (of type String).

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	comment An optional user supplied comment.
String	name Simple name or fully qualified name of generated class.

Element Detail

name

public abstract String name

Simple name or fully qualified name of generated class. If name is not specified (set to $(N/A) then a reasonable class name will be generated automatically. If name is present but is unqualifed a package name will be supplied automatically from the associcated interface. May also (as all other annotated values) be overruled globally with equivalent annotation processor key (even though it is generally a bad idea because of name clashes when generating multiple classes).

Returns:

The short name or fully qualified name of the generated class.

Default:

"$(N/A)"

comment

public abstract String comment

An optional user supplied comment. Not used for anything by default but could potentially be used in a custom template or by a build tool. It is up to you what to use this option for. This comment if present takes precedence over any similar comment specified on other VALJOGen annotations.

Returns:

An optional comment.

Default:

"$(N/A)"