xapi.platform

Annotation Type Platform

@Retention(value=RUNTIME)
@Target(value=ANNOTATION_TYPE)
public @interface Platform

This annotation is used to annotate other annotations which define a particular injection platform. This allows devs to create their own custom injection targets to suit whatever java environment imaginable. The gwt injector searches classes annotated with the provider annotations, InstanceDefault, InstanceOverride, SingletonDefault and SingletonOverride and any annotations found annotated with @Platform will then make a reflective call to the method isGwt(). If the method is missing or returns false, that annotation is ignored. If an annotation is found, a call is then made to isDevMode(), which, if present, must match the expected production mode status. The jre injector will also check any providers for platform annotations, except it requires the annotations to provide an isJava() method, which must return true. The jre injector will also make a reflective call to .version(), which, if it returns a double, will be matched to the current runtime environment. Any versions lower than current runtime will be ignored. This allows library writers to create java 7 or java 8 implementations, but deliver java 6 (or even java 5) specific implementations. Java 5 and lower are not supported due to lack of annotation support. Any platform annotation which supplies a runtimeSelector() method which returns a Class will be able to arbitrarily disable any type using a reflectively instantiated PlatformSelector. A gwt runtime will receive the StandardGeneratorContext object and TypeOracle as parameters. A jre runtime will receive an instance of whatever class the main Injector interface is bound to as its parameter.

Author:

"James X. Nelson (james@wetheinter.net)"

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<? extends Annotation>[]	fallback
boolean	isDebug
boolean	isDevMode
boolean	isGwt
boolean	isJava
boolean	isMobile
boolean	isServer
Class<? extends PlatformSelector>	selector

Element Detail

isJava

public abstract boolean isJava

Returns:

true if running in a real JRE; false for transpiled source

Default:

true

isGwt

public abstract boolean isGwt

Returns:

true if running in any gwt runtime environment. DevMode will return true for isJava, isGwt and isDevMode.

Default:

false

isServer

public abstract boolean isServer

Returns:

true if running on a server. All clients ignore server types

Default:

false

isMobile

public abstract boolean isMobile

Returns:

true if this target is mobile.

Default:

false

isDebug

public abstract boolean isDebug

Returns:

true if this is a debug platform; i.e., it is used in a test case, or when you need to inject a debug implementation over top a production type. Debug types are allowed in any platform, and will only be used if the property xapi.debug=true

Default:

false

isDevMode

public abstract boolean isDevMode

Returns:

true for platforms that are specifically for development purposes. This differs from debug in that a dev mode platform has a "production enviro", which is when a developer is using the tools. A dev mode platform can still have debug types injected for when developing the development tools. :)

Default:

false

selector

public abstract Class<? extends PlatformSelector> selector

Returns:

a class to use as a runtime platform selector. Not really implemented yet.

Default:

xapi.platform.PlatformSelector.AlwaysTrue.class

fallback

public abstract Class<? extends Annotation>[] fallback

Returns:

a set of platforms to allow as fallback.

Default:

{}