summaryrefslogtreecommitdiff
path: root/src/main/java/net/transit/network/system/INode.java
blob: 2dc368649b1adfc2ba9f8a997480b9ddd2718117 (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
package net.transit.network.system;

import net.transit.network.swap.IAcceptor;
import net.transit.network.swap.IProvider;

/**
 * @author Kyle Gunger
 * @apiNote A node inside or outside a system. Provides acceptors and providers to other nodes.
 */
public interface INode
{
	/**Returns the groupIDs of groups the node provide
	 * 
	 * @return String[]
	 */
	public String[] groupsProvided();
	
	/**Get the system managing the node or {@code null} if there isn't one
	 * 
	 * @return ISystem
	 */
	public ISystem getSystem();
	
	/**Returns {@code true} if the node provides IAcceptors
	 * 
	 * @return boolean
	 */
	public boolean isAcceptor();
	
	/**Returns an IAcceptor or {@code null} depending on the requester and group
	 * 
	 * @param requester The object requesting the IAcceptor
	 * @param group
	 * @return IAcceptor
	 */
	public IAcceptor<?> requestAcceptor(Object requester, String group);
	
	/**Returns {@code true} if the node provides IProviders
	 * 
	 */
	public boolean isProvider();
	
	/**Returns an IProvider or {@code null} depending on the requester and group
	 * 
	 * @param requester The object requesting the IProvider
	 * @param group
	 * @return IProvider
	 */
	public IProvider<?> requestProvider(Object requestor, String group);
}