org.netbeans.modules.parsing.spi.indexing

Annotation Type ConstrainedBinaryIndexer.Registration

@Target(value=TYPE)
 @Retention(value=SOURCE)
public static @interface ConstrainedBinaryIndexer.Registration

The annotation to register ConstrainedBinaryIndexer with constraints on the scanned binary. The registered indexer is loaded and executed only of the constraints are fulfilled.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	indexerName Return the name of this indexer.
int	indexVersion Return the version stamp of the schema that is currently being stored by this indexer.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	mimeType One or more mime types that have to be present inside of the binary to enable this indexer.
String	namePattern Regular expression of file names which have to be present inside of the binary to enable this indexer.
String[]	requiredResource At least one of these resources has to be present to trigger this indexer.

Element Detail

indexerName

public abstract String indexerName

Return the name of this indexer. This name should be unique because GSF will use this name to produce a separate data directory for each indexer where it has its own storage.

Returns:

The indexer name. This does not need to be localized since it is never shown to the user, but should contain filesystem safe characters.

See Also:

BinaryIndexerFactory

indexVersion

public abstract int indexVersion

Return the version stamp of the schema that is currently being stored by this indexer. Along with the index name this string will be used to create a unique data directory for the database. Whenever you incompatibly change what is stored by the indexer, update the version stamp.

Returns:

The version stamp of the current index.

See Also:

BinaryIndexerFactory

requiredResource

public abstract String[] requiredResource

At least one of these resources has to be present to trigger this indexer. Use {} if the resource check should be skipped.

Returns:

one or more relative paths inside the binary files that will be checked for existence. The paths are delimited by '/' and do not start with delimiter.

Default:

{}

mimeType

public abstract String[] mimeType

One or more mime types that have to be present inside of the binary to enable this indexer. Use {} if the mime type check should be skipped. The mime type check can be expensive especially for mime types which require file reading, for such mime types consider to prefer name pattern.

Returns:

one or more mimetypes this indexer processing

Default:

{}

namePattern

public abstract String namePattern

Regular expression of file names which have to be present inside of the binary to enable this indexer. Use "" if the file name check should be skipped.

Returns:

file name regular expression this indexer processing

Since:

1.50

Default:

""