Module net.luis.utils
Package net.luis.utils.io.data.config

Annotation Interface ReadOnly

@Documented @Retention(RUNTIME) @Target(RECORD_COMPONENT) public @interface ReadOnly
Annotation for record components of an io configuration.
The annotated record component is used for reading only.

The value of the annotation defines dependencies to other record components.
If the value is empty, the record component is not dependent on any other record component.
The dependencies must also be annotated with ReadOnly.

The dependencies must be boolean expressions and can be combined with the following operators:
key1 == 10 - The record component is dependent on key1 only if key1 is equal to 10.
key1 && key2 - The record component is dependent on key1 and key2.

The dependencies are not checked or used, they are only for documentation purposes.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String @NotNull []
    value
    The dependencies of the annotated record component.
    Each dependency must be a boolean expression.

  • Element Details

    • value

      String @NotNull [] value
      The dependencies of the annotated record component.
      Each dependency must be a boolean expression.
      Returns:
      The dependencies
      Default:
      {}