Package guru.mikelue.foxglove.annotation

Interface GenDataInspector

public interface GenDataInspector

A convenient interface to process objects defined by GenData.

Method Summary

Modifier and Type	Method	Description
GenData	genData()	Returns the annotation instance of GenData.
int	numberOfTableFacets()	Returns the number of table facets defined in GenData.
static GenDataInspector	of(GenData genData)	Creates an instance of GenDataInspector.
boolean	useDefaultDataGenerator()	Indicates whether the default data generator is used.
boolean	useDefaultTableFacets()	Indicates whether the default table facets are used.

Method Details

of

static GenDataInspector of(GenData genData)

Creates an instance of GenDataInspector.

Parameters:

genData - The annotation instance of GenData

Returns:

The instance of GenDataInspector

genData

GenData genData()

Returns the annotation instance of GenData.

Returns:

The annotation instance of GenData

numberOfTableFacets

int numberOfTableFacets()

Returns the number of table facets defined in GenData.

Returns:

The number of table facets

useDefaultDataGenerator

boolean useDefaultDataGenerator()

Indicates whether the default data generator is used.

The default data generator is used when both of the following conditions are met:

• The GenData.generatorName() is not set (empty string),
• The GenData.generator() is set to GenData.FallbackDataGeneratorProvider.

Returns:

true if the default data generator is used; false otherwise

useDefaultTableFacets

boolean useDefaultTableFacets()

Indicates whether the default table facets are used.

The default table facets are used when all of the following conditions are met:

• The GenData.facetsNames() is not set (empty array),
• The GenData.value() is not set (empty array),
• The GenData.facets() is not set (empty array).

Returns:

true if the default table facets are used; false otherwise