xapi.platform.DevPlatform Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of xapi-dev Show documentation

Everything needed to run a comprehensive dev environment. Just type X_ and pick a service from autocomplete; new dev modules will be added as they are built. The only dev service not included in the uber jar is xapi-dev-maven, as it includes all runtime dependencies of maven, adding ~4 seconds to build time, and 6 megabytes to the final output jar size (without xapi-dev-maven, it's ~1MB).

The newest version!

package xapi.platform;

import java.lang.annotation.Annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import xapi.platform.PlatformSelector.AlwaysTrue;

/**
 * This annotation is used for types that should be injected into build tools,
 * but not into production environments.  The dev platform is where codegen,
 * maven plugins and transpiler code is placed.  It can also be used for
 * unit testing, provided you set the xapi.platform property to
 * xapi.platform.DevPlatform; you may wish to create your own
 * test platform(s), though it's easier to simply use DevPlatform, and
 * just create different platform selectors to create testing environments.
 *
 * @author "James X. Nelson ([email protected])"
 *
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Platform(
  isDebug=true,
  fallback = JrePlatform.class
)
public @interface DevPlatform {

  Class runtimeSelector() default AlwaysTrue.class;
  Class[] fallback() default JrePlatform.class;
}