xapi.annotation.compile

Annotation Type Dependency

@Documented
 @Target(value={})
 @Retention(value=RUNTIME)
 @MirroredAnnotation
public @interface Dependency

This annotation is used to describe a dependency in a compile.

value() is the main descriptor used for the dependency; for Dependency.DependencyType.RELATIVE and Dependency.DependencyType.ABSOLUTE, artifactId() is where you will specify the filename you wish to locate.

When using Dependency.DependencyType.MAVEN, you will specify all three fields as a normal dependency, value() is the artifactId, while groupId() and version() are exactly what you expect.

Any property ${keys} found in any of the annotation values will be replaced with whatever X_Properties.getProperty(String, String) returns (if there is no property set, you will get "keys" as the value for ${keys}). The PropertiesService defaults to using System.properties, though you are free to inject your own property provider.

Note that Dependency.DependencyType.RELATIVE will check groupId() for a value to use as the base of the relative uri; special values like DIR_TEMP, DIR_BIN, DIR_GEN or DIR_LAUNCH can be used as groupId() to specify where the resource must be found.
Providing no groupId() when using a Dependency.DependencyType.RELATIVE Dependency will case all of the special dirs to be searched in the following order:

• bin
• temp
• gen
• launch

Note that changing the version() will cause the default compilers to discard the classloader / existing runtime environment.

Author:

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

Field Summary

Fields

Modifier and Type	Fields and Description
static String	DIR_BIN The bin directory; whatever directory we can ascertain that the Dependency was launched from.
static String	DIR_GEN The gen directory; must be set as a system property (or in whatever PropertyService is used by X_Properties).
static String	DIR_LAUNCH The directory in which the current process was launched, new File(".")
static String	DIR_SOURCE The bin directory; whatever directory we can ascertain that the Dependency was launched from.
static String	DIR_TARGET The gen directory; must be set as a system property (or in whatever PropertyService is used by X_Properties).
static String	DIR_TEMP The temporary directory; default is OS-temp directory (/tmp)
static String	DIR_WAR The war directory; must be set as a system property (or in whatever PropertyService is used by X_Properties).

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	classifier
Dependency.DependencyType	dependencyType
String	groupId
String	version

Field Detail

DIR_TEMP

public static final String DIR_TEMP

The temporary directory; default is OS-temp directory (/tmp)

DIR_LAUNCH

public static final String DIR_LAUNCH

The directory in which the current process was launched, new File(".")

DIR_BIN

public static final String DIR_BIN

The bin directory; whatever directory we can ascertain that the Dependency was launched from. try { return getClassloader().findResource(toClassLocation(Dependency.class.getName())); } catch (Exception e) { return Dependency.class.getProtectionDomain().getCodesource().getLocation(); }

DIR_SOURCE

public static final String DIR_SOURCE

The bin directory; whatever directory we can ascertain that the Dependency was launched from. try { return getClassloader().findResource(toJavaLocation(Dependency.class.getName())); // toJavaLocation = name.replace(packageName, packageName.replace('.', '/') // + getSimpleName.split("$")[0] + ".java" } catch (Exception e) { return Dependency.class.getProtectionDomain().getCodesource().getLocation(); }

DIR_GEN

public static final String DIR_GEN

The gen directory; must be set as a system property (or in whatever PropertyService is used by X_Properties). Some compilers, like the gwt compiler, will fill these values for you.

DIR_TARGET

public static final String DIR_TARGET

The gen directory; must be set as a system property (or in whatever PropertyService is used by X_Properties). Some implementations, like the maven launcher, will fill this value in for you. The gwt compiler will default this special location to the WAR/moduleName directory.

DIR_WAR

public static final String DIR_WAR

The war directory; must be set as a system property (or in whatever PropertyService is used by X_Properties). Some implementations, like the gwt compiler, will fill this value in for you.

Element Detail

value

public abstract String value

groupId

public abstract String groupId

Default:

""

version

public abstract String version

Default:

""

classifier

public abstract String classifier

Default:

""

dependencyType

public abstract Dependency.DependencyType dependencyType

Default:

xapi.annotation.compile.Dependency.DependencyType.RELATIVE