summaryrefslogtreecommitdiff
path: root/src/main/java/bjc/data/Context.java
blob: 7efdc4d46b6c40cf8ff3af5092ca9d50febb71ac (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
package bjc.data;

/**
 * Represents a 'context' which is a hierarchical set of objects.
 * @author Ben Culkin
 *
 */
public interface Context {
	/**
	 * Register an object with this context.
	 * 
	 * @param name The name of the object.
	 * @param o The object to register.
	 */
	void register(String name, Object o);

	/**
	 * Get the parent of this context.
	 * 
	 * @return The parent of this context.
	 */
	Context getParent();

	/**
	 * Get an object from this context.
	 * 
	 * @param name The name of the object.
	 * 
	 * @return The object bound to that name.
	 */
	Object get(String name);
	
	/**
	 * Get an object which is an instance of the provided class or a subclass
	 * thereof.
	 * 
	 * @param <T> The type of the object.
	 * 
	 * @param contract The class of the object.
	 * 
	 * @return An instance of the provided class.
	 */
	<T> T get(Class<T> contract);
	
	/**
	 * Get a named object which is an instance of the provided class or a subclass
	 * thereof.
	 * 
	 * @param <T> The type of the object.
	 * 
	 * @param name The name of the object
	 * @param contract The class of the object.
	 * 
	 * @return An instance of the provided class, with the given name..
	 */
	default <T> T get(String name, Class<T> contract) {
		Object obj = get(name);
		return obj == null 
				? getParent().get(name, contract) 
						: contract.cast(obj);
	};
}