com.hcl.domino.richtext.annotation

Annotation Type StructureMember

@Retention(value=RUNTIME)
public @interface StructureMember

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name
Class<?>	type Defines the Java type of the structure member.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	bitfield
int	length Specifies the length of the embedded structure array, when type() is an array type.
boolean	unsigned

Element Detail

name

public abstract String name

Returns:

the name of the member in the structure

type

public abstract Class<?> type

Defines the Java type of the structure member. This may be one of:

• A primitive number type
• An enum that implements INumberEnum
• A direct sub-interface of MemoryStructure

If the value is unsigned in C, then unsigned() should be true and this type should be one primitive number size higher than the byte size of the storage type. For example, an unsigned WORD is represented by int.

If the value is a bit field in C, such as a "Flags" field, then bitfield() should be true and this type should be the type of a single flag, and not a collection type.

Returns:

the Java type of the member

unsigned

public abstract boolean unsigned

Returns:

whether the value of the structure member is an unsigned integer type

Default:

false

bitfield

public abstract boolean bitfield

Returns:

whether the storage represents a bitfield type, such as a Flags field

Default:

false

length

public abstract int length

Specifies the length of the embedded structure array, when type() is an array type.

Returns:

the length of the structure array

Default:

1