com.speedment.annotation

Annotation Type Api

@Retention(value=RUNTIME)
 @Target(value={METHOD,TYPE,CONSTRUCTOR})
public @interface Api

Marks a Method, Type or Constructor as an API. An API marked entity with a certain API version will remain "Compatible" across new software releases indefinitely , for that particular API version.

"Compatible" is defined as follows:

Method: Its signature (i.e. name and parameters), and return type will remain.

Interface: Its name and all its declared methods with its return type and signature and static fields will remain. New methods and static field might be added.

Enum: Its elements will remain and their individual order will remain. New elements might be added.

Author:

pemi

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	version Returns the current API version.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	snapshot Returns if this API version is a snapshot, i.e.

Element Detail

version

public abstract String version

Returns the current API version.

Returns:

the current API version.

snapshot

public abstract boolean snapshot

Returns if this API version is a snapshot, i.e. it is not yet "frozen" and may change within the given API version.

Returns:

true if this API version is a snapshot, false otherwise.

Default:

false