xapi.annotation.compile

Annotation Type Resource

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

A compile-time resource; default behavior is to treat value() as a resource location, and use the current thread classloader to get that resource.

The type() method is used to specify what kind of resource is being included; allowing a compiler service to know how it should be interpretting the annotation value.

This annotation is only meant to be used as values for other annotations, and its implementation is dependent on the compiler class using it.

The use of the qualifier() method is strictly implementation dependent; it is used when the default Resource.ResourceTypes are not enough to fully describe how to treat the given dependency.

Author:

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

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	qualifier
boolean	required
Resource.ResourceType	type

Element Detail

value

public abstract String value

type

public abstract Resource.ResourceType type

Default:

xapi.annotation.compile.Resource.ResourceType.CLASSPATH_RESOURCE

qualifier

public abstract String qualifier

Default:

""

required

public abstract boolean required

Returns:

false if it's ok that a requested resource is not found; default is true.

Default:

true