Package org.neo4j.gds.annotation

Annotation Interface Configuration

@Documented
@Target(TYPE)
@Retention(CLASS)
public @interface Configuration

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static @interface	Configuration.Check	The annotated method will be invoked internally to validate invariants after instance has been created, but before returned to a client.
static @interface	Configuration.CollectKeys	Annotated function will return the list of configuration keys.
static @interface	Configuration.ConvertWith	This annotation can be used together with Configuration.Key or Configuration.Parameter.
static @interface	Configuration.DoubleRange	Input for the annotated configuration field storing a Double, will be validated if it is in the given range
static @interface	Configuration.GraphStoreValidation	The annotated method will be used to insert the implementation of validating a given graphStore.
static @interface	Configuration.GraphStoreValidationCheck	The annotated method will be used to insert the implementation of Configuration.GraphStoreValidation to verify the configuration is valid for the given graphStore.
static @interface	Configuration.Ignore	Used to specify which interface methods to ignore by the ConfigurationProcessor.
static @interface	Configuration.IntegerRange	Input for the annotated configuration field storing an Integer, will be validated if it is in the given range.
static @interface	Configuration.Key	By default, a configuration field is resolved in the CypherMapWrapper parameter with the method name as the expected key.
static @interface	Configuration.LongRange	Input for the annotated configuration field storing a Long, will be validated if it is in the given range
static @interface	Configuration.Parameter	Configuration field is expected to be passed to the constructor as a parameter.
static @interface	Configuration.ToMap	Annotated function will return the map representation of the configuration.
static @interface	Configuration.ToMapValue	This annotation can be used together with Configuration.Key or Configuration.Parameter.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	value	Name of the generated class.

Element Details

value

String value

Name of the generated class.

If not manually set, the value is set to the annotation class name with an "Impl" suffix:

 @Configuration
 interface Foo { }

 @Generated
 public class FooImpl { }
 

Default:

""