Package dev.jaxydog.astral.register

Annotation Interface IgnoreRegistration

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

Marks a field as intentionally ignored during the automatic registration process.

By default, all environments are ignored. The ignored environments can be configured via the annotation's arguments.

Since:

2.0.0

See Also:

• Registered
• Environment

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
boolean	client	Configures whether registration within the client environment should be ignored.
boolean	common	Configures whether registration within the common environment should be ignored.
boolean	generator	Configures whether registration within the data generation environment should be ignored.
boolean	server	Configures whether registration within the server environment should be ignored.

Element Details

common

boolean common

Configures whether registration within the common environment should be ignored.

Note that this is distinctly different from client() and server().

This field is true by default.

Returns:

Whether the common environment is ignored.

Since:

2.0.0

Default:

true

client

boolean client

Configures whether registration within the client environment should be ignored.

This field is true by default.

Returns:

Whether the client environment is ignored.

Since:

2.0.0

Default:

true

server

boolean server

Configures whether registration within the server environment should be ignored.

This field is true by default.

Returns:

Whether the server environment is ignored.

Since:

2.0.0

Default:

true

generator

boolean generator

Configures whether registration within the data generation environment should be ignored.

This field is true by default.

Returns:

Whether the generation environment is ignored.

Since:

2.0.0

Default:

true