README.md

jinject-framework

JInject is a small binding framework coupled with a dependency injection system.

It provides :

• Injection of dependencies by fields or by constructor
• Binding system (key, value, ) (bind any type to anything)
• Events
• Binding events to specifics actions
• Context to facilitate usage

Features to come :

• MVC context

Basic usage

Create a context

You have to create a derived class of AbstractContext :

public class MyContext extends AbstractContext {
	
	@Override
	public void setupBindings() {
	  // your bindings
	}

	@Override
	public void setupActions() {
	  // your actions (event to action)
	}

	@Override
	public void start() {
		// this method is called after all bindings setup
		// you can add logic here like create a view
	}
}

Edit your bindings

You can add now bindings in setupBindings() method using the injectionBinder :

@Override
public void setupBindings() {
  // bind by type
  injectionBinder.bind(IMyInterface.class).to(MyConcreteClass.class); 
  
  // bind by instance, to prevent replacing previous binding, name it !
  injectionBinder.bind(IOtherInterface.class).to(new OtherObject()).toName("NAMED"); 
  
  // bind by name
  injectionBinder.bind(IOtherInterface.class).to(new MyObject()).toName("MY_OBJECT");
  
  // bind by value and lock the binding to prevent later modifications
  injectionBinder.bind(MySpecialClass.class).to(new MySpecialClass()).lock(); 
}

Create a test class

It's time to try your work.

Create a test class with specific annotation to inject content :

// test class
public class MyTestClass {
  @Inject
  private MySpecialClass mySpecialClass; // injected by value
  
  @Inject
  private IOtherObject otherObject; // new object instance
  
  @Inject("NAMED")
  private IOtherObject otherObject; // injected by value, always the same object accross all instances
}


// for example, you can implement MySpecialClass like this and observe the cascade injection
public class MySpecialClass {
  @Inject
  private IMyInterface concreteClassInstance; // new instance
  
  @Inject("MY_OBJECT")
  private IOtherInterface otherObject; // injected by value, always the same object
}

Create it and register this class with the context.

@Override
public void start() {
  MyTestClass test = new MyTestClass();
  register(test); // cascade injection
  
  System.out.println(test.mySpecialClass.concreteClassInstance);
}

Binding examples

Some examples to show you what you can bind (actually almost everything) :

IBinder binder = new Binder();
binder.bind(IMyInterface.class).to(MyConcreteClass.class);  // bind interface to concrete class
binder.bind(ConcreteClass.class).to(ConcreteClass.class); // bind concrete class to itself 
binder.bind(ConcreteClass.class).to(instanceOfMyConcreteClass); // bind concrete class to an instance
binder.bind(ConcreteClass.class).to(instanceOfMyConcreteClass).toName("myInstance"); // bind concrete class to an instance and to a name
binder.bind(ConcreteClass.class).to(instanceOfMyConcreteClass).toName(MyEnum.ENUM_VALUE); // bind concrete class to an instance and to an enum

// others :)
binder.bind(100).to("Hello world");  // binding primitive (wrappers) to String object
binder.bind("Hi jack").to(instanceObject);  // String to an instance...
binder.bind("me").to("Thibaud Giovannetti"); // String to string

Signals (actions)

Signals is a way to execute specials actions previously binded. For instance, you can bind a ItemPickedUpEvent to a special action who will add life to the player. JInject implements some events, but due to the implementation of the java langage their usage is not trivial at this time.

ActionBinder actionBinder = new ActionBinder(new Injector(new Reflector())); // most of the time you won't do this cause it's already done in Context
actionBinder.bind(MySpecialEvent.class).to(MyAction.class);

// Declarations (differents files)
// events
class Events {
	public static class MySimpleEvent extends SimpleEvent {}
	public static class MyUnaryEvent extends UnaryEvent<String> {}
	public static class MyBinaryTestEvent extends BinaryEvent<String, Integer> {}
	public static class MyBinaryTestComplexEvent extends BinaryEvent<String, IOther> {}
	public static class MyBinaryTestComplexInheritedEvent extends BinaryEvent<String, Other> {}
	public static class MyTernaryTestEvent extends BinaryEvent<String, Integer> {}
}

// implementation of the MyAction class
class MyAction extends AbstractAction {
	@Inject
	private Integer myInt;
	
	@Override
	public void execute(){
    	System.out.println("my int =  " + myInt); // display the value sent by the event
	}
}

// in a view for example
class MyView {
	@Inject
	private MySpecialEvent event; // inject the default event

	public void fireEventExample(){
		// dispatch the event
		event.fire(100); // this will automatically instantiate a MyAction object, inject it with the param and call it's execute method !
	}
}

If you need to send custom objects throught events, you need to add them to an injectionBinder first.

View

Doc coming...

Version

JInject v0.3