GRegistry

A simple gosu implementation of code registry where you can retrieve a group of classes marked by custom annotation.

IEnlist Interface

IEnlist is a marker interface where all the classes implementing it will become part of the registry. Moreover, all the classes marked by this interface must also be marked as Serializable. Also, it is recommended that these classes must not have any state associated with it.

Custom Annotation

A custom annotation can be defined with the following syntax:

uses java.lang.annotation.ElementType
uses java.lang.annotation.Retention
uses java.lang.annotation.Target

@Target({ElementType.TYPE})
@Retention(RUNTIME)
annotation <ANNOTATION_NAME> {

	/* Only use this if you want to associate an interface with the annotation.
	function implementInterface() : String = "<FULLY_QUALIFIED_INTERFACE_NAME>"
	*/

}

GScanner.Instance

The Instance static property of GScanner class is only way to have an instance of itself.

GScanner Instance Methods/Property

The exec parameter of the process method

The exec parameter is a gosu block parameter that will receive one at a time an instance of annotation and an instance of a class that has it. They are represented by the variables annotation and instance, respectively. The first parameter of the exec block is a variable called context. This holds what state the process methods has gone through and will be part of the IProcessOutput return type.

If you are processing a particular class you have an option to stop the processing or continue with the next class in queue. Return false to stop the process method to receive the next class otherwise return true. If you return false the SubStatus field attached to the IProcessOutput will have the value ProcessStatus.CUT_SHORT otherwise it is the same has the Status field.

Therefore, the exec block is where the effective way to do what you wanted to do to the classes marked by your custom annotation. Check the Sample Usage under the Usage section below.

IAnnotationMetaBase Interface

The implementation of this interface holds the mapping of the instance of the annotation against the class type it was attached.

IProcessOutput Interface

The implementation of this interface holds the status after completing the execution of the process method.

Properties

JVM Options

The configurable part of GRegistry.

Usage

As a Code Dependency to Your Gosu Project

Using gradle, this can be added as a dependency entry like the following:

compile group: 'xyz.ronella.gosu', name: 'gregistry', version: '1.3.0'

Sample Usage

MyAnnotation Definition

uses java.lang.annotation.ElementType
uses java.lang.annotation.Retention
uses java.lang.annotation.Target

@Target({ElementType.TYPE})
@Retention(RUNTIME)
annotation MyAnnotation {
  function name() : String
}

ManagedClass Definition

uses xyz.ronella.gosu.gregistry.IEnlist
uses java.io.Serializable

@MyAnnotation("World")
class ManagedClass implements IEnlist, Serializable {

  function hello(name : String) {
    print("Hello ${name}")
  }

}

Processing MyAnnotation Classes

uses xyz.ronella.gosu.gregistry.GScanner

GScanner.Instance.process<MyAnnotation, ManagedClass>(
    \ ___ctx, ___annotation, ___instance -> { //Execute logic
    ___instance.hello(___annotation.name())
  return true
})

The output will be as follows

Hello World

The Hello part of the output is coming from the ManagedClass itself while the World part is coming from the annotation attached to the ManagedClass.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Build

Changelog

Author

• Ronaldo Webb