Package ghidra.util.database.annot

Annotation Interface DBAnnotatedField

@Target(FIELD)
@Retention(RUNTIME)
public @interface DBAnnotatedField

Mark a field to be stored in a table column

See Also:

• DBAnnotatedObject

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DBAnnotatedField.DefaultCodec<OT extends DBAnnotatedObject,FT extends Field>	A placeholder class

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	column	The name of the column

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
Class<? extends DBCachedObjectStoreFactory.DBFieldCodec>	codec	Specify a custom codec
boolean	indexed	True to index the column
boolean	sparse	True to use sparse storage

Element Details

column

String column

The name of the column

There should be a DBAnnotatedColumn annotation with the same column name

indexed

boolean indexed

True to index the column

Default:

false

sparse

boolean sparse

True to use sparse storage

If the Field used by the codec does not support null values, this can be set to true to allow null values.

Default:

false

codec

Class<? extends DBCachedObjectStoreFactory.DBFieldCodec> codec

Specify a custom codec

This is not required for types supported directly by a Field.

See Also:

• DBCachedObjectStoreFactory.DBFieldCodec

Default:

ghidra.util.database.annot.DBAnnotatedField.DefaultCodec.class