Annotation Type SherlockModule


  • @Documented
    @Retention(RUNTIME)
    @Target(TYPE)
    public @interface SherlockModule
    Annotation to mark a module which should be register to the Sherlock engine on startup
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String name
      The name of the module, for easy identification
      Side side
      Is SherlockEngine running locally (Side.CLIENT) or on a server (Side.SERVER)
      java.lang.String version
      Version string for the module, help users track whether they are up to date
    • Element Detail

      • name

        java.lang.String name
        The name of the module, for easy identification
        Returns:
        name
        Default:
        ""
      • side

        Side side
        Is SherlockEngine running locally (Side.CLIENT) or on a server (Side.SERVER)
        Returns:
        side
        Default:
        uk.ac.warwick.dcs.sherlock.api.util.Side.UNKNOWN
      • version

        java.lang.String version
        Version string for the module, help users track whether they are up to date
        Returns:
        version
        Default:
        ""