pro.projo.interfaces.annotation

Annotation Type Dtd

@Target(value=PACKAGE)
 @Retention(value=RUNTIME)
 @Repeatable(value=Dtds.class)
public @interface Dtd

The Dtd annotation captures the necessary information for generating an API from a DTD.

Author:

Mirko Raner

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	path

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Alias[]	aliases
Class<? extends AttributeNameConverter>	attributeNameConverter
Attribute[]	attributes
Class<?>	baseInterface Returns the base interface to be used for non-empty, non-text elements.
Class<?>	baseInterfaceEmpty
Class<?>	baseInterfaceText
String	contentNameFormat
String	elementNameFormat
int	implicitTypeParameters Indicates the number of implicit type parameters that are present in the base interfaces.
Class<?>	mixedContentInterface
Options	options

Element Detail

path

public abstract String path

Returns:

the path to the main DTD file (may reference additional entity files)

baseInterface

public abstract Class<?> baseInterface

Returns the base interface to be used for non-empty, non-text elements. This must be an interface with three type parameters: the first parameter for the parent content element type, the second for the element's own content input type, and the third for the element's content output type. For unrestricted content, the content input type and content output type will typically be the same, and the code generator will assign the same type for both type variables. However, for example for sequences of mandatory content objects, the code generator will create a type hierarchy of a base content type, and several individual types for the members of the first, second, third, etc. element of the sequence. The base interface will be parameterized with the sequences's first element type and the content input type, and the base content type as the output type.

Returns:

the default base interface to use for model elements (Object indicates that no specific base interface will be extended)

Default:

java.lang.Object.class

baseInterfaceEmpty

public abstract Class<?> baseInterfaceEmpty

Returns:

the default base interface to use for empty (or "void") model elements (this must be an interface with one type parameter, which designates the parent content element type; Object indicates that no specific base interface will be extended)

Default:

java.lang.Object.class

baseInterfaceText

public abstract Class<?> baseInterfaceText

Returns:

the default base interface to use for mixed content elements that do not have any permitted child elements, i.e. they can only contain plain text (this must be an interface with one type parameter, which designates the parent content element type; Object indicates that no specific base interface will be extended)

Default:

java.lang.Object.class

mixedContentInterface

public abstract Class<?> mixedContentInterface

Returns:

the default base interface to use for mixed content types - unlike the other interfaces this interface serves as the base for content types not for element types and will typically contain generic methods for interspersing plain text content with nested elements; this interface must have one type parameter, which designates the parent content element type; the default value of Object indicates that no specific base interface will be extended

Default:

java.lang.Object.class

elementNameFormat

public abstract String elementNameFormat

Returns:

the name format for generated element interfaces (by default this is just the capitalized element name)

See Also:

MessageFormat

Default:

"{0}"

contentNameFormat

public abstract String contentNameFormat

Returns:

the name format for generated content interfaces (by default this is the capitalized element name followed by the word Content)

See Also:

MessageFormat

Default:

"{0}Content"

attributeNameConverter

public abstract Class<? extends AttributeNameConverter> attributeNameConverter

Returns:

the AttributeNameConverter to be used for converting XML/SGML attribute names to Java method names

Default:

pro.projo.interfaces.annotation.utilities.DefaultAttributeNameConverter.class

options

public abstract Options options

Returns:

additional code generation options for this Dtd

Default:

@pro.projo.interfaces.annotation.Options

aliases

public abstract Alias[] aliases

Returns:

aliases for elements (if any)

Default:

{}

attributes

public abstract Attribute[] attributes

Returns:

custom attributes for elements (if any)

Default:

{}

implicitTypeParameters

public abstract int implicitTypeParameters

Indicates the number of implicit type parameters that are present in the base interfaces. This could be due to implicit type parameters inherited from enclosing classes, or additional type parameters generated by some (non-Java) JVM languages. Default is 0.

Returns:

number of implicit type parameters (if any)

Default:

0