summaryrefslogtreecommitdiff
path: root/israfil-foundation-container/src/main/java/net/israfil/foundation/container/AutoWiringAdapter.java
blob: 56436a5d9884fbdcb48635f05e467e853279607d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
/*
 * Copyright (c) 2008 Israfil Consulting Services Corporation
 * Copyright (c) 2008 Christian Edward Gruber
 * All Rights Reserved
 * 
 * This software is licensed under the Berkeley Standard Distribution license,
 * (BSD license), as defined below:
 * 
 * Redistribution and use in source and binary forms, with or without 
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this 
 *    list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice, 
 *    this list of conditions and the following disclaimer in the documentation 
 *    and/or other materials provided with the distribution.
 * 3. Neither the name of Israfil Consulting Services nor the names of its contributors 
 *    may be used to endorse or promote products derived from this software without 
 *    specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
 * IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, 
 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 
 * OF SUCH DAMAGE.
 * 
 * $Id: Copyright.java 618 2008-04-14 14:03:03Z christianedwardgruber $
 */
package net.israfil.foundation.container;

/** 
 * An adapter interface that's used in the "AutoWiringContainer"
 * to allow the user to specify a component's dependencies upon registration.
 * This is not ideal, in that it's not auto-discovered constructor-based 
 * dependency injection, but since dynamic reflection is not available in the 
 * J2ME CLDC 1.1 spec, an alternate and generic injection mechanism 
 * is necessary.  Implementors of this interface should be CLDC safe.
 * 
 * @author <a href="mailto:cgruber@israfil.net">Christian Edward Gruber </a>
 */
public interface AutoWiringAdapter {

	/** 
	 * This method should return a list of keys defining the dependencies
	 * this object requires to operate, in the order expected by the
	 * create(Object[]) method.
	 */
	public Object[] dependencies();
	
	/** 
	 * Returns the type that this adapter will create.  This should be the 
	 * most concrete (narrowest) common type this adapter will create, if 
	 * there is more than one possibility.
	 */
	public Class getType();

	/** 
	 * A method that implementors use to create a component given a set of 
	 * parameters.  Callers must return the parameters in the order provided
	 * by the dependencies() method.
	 */
	public Object create(Object[] parameters) throws IllegalAccessException, InstantiationException;

}