Package dev.crafty.core.config.annotation

Annotation Interface ConfigurationFile

@Retention(RUNTIME) @Target(TYPE) public @interface ConfigurationFile
Annotation to mark a class as a configuration holder. This annotation specifies which configuration file should be used for the annotated class.
Since:
1.0.0

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    file
    The path to the configuration file, relative to the plugin's data folder.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    createIfNotExists
    Whether to automatically create the configuration file if it doesn't exist.

  • Element Details

    • file

      String file
      The path to the configuration file, relative to the plugin's data folder.
      Returns:
      The configuration file path

    • createIfNotExists

      boolean createIfNotExists
      Whether to automatically create the configuration file if it doesn't exist.
      Returns:
      True if the file should be created automatically, false otherwise
      Default:
      true