View Javadoc

1   package twcsckernel.serverKernel.io;
2   
3   import java.io.IOException;
4   import java.util.Map;
5   
6   import twcsckernel.serverKernel.utils.TypeData;
7   
8   /***
9    * Interfejs operacji I/O dla zarejestrowanych typów użytkowników.
10   * 
11   * @author VMD Group
12   * 
13   */
14  public interface TypeIO {
15  	/***
16  	 * Wczytuje zarejestrowane typy użytkowników.
17  	 * 
18  	 * @return - mapa zarejestrowanych typów <nazwa_typu,dane>
19  	 * @throws IOException -
20  	 *             wyjątek rzucany w przypadku błędu odczytu
21  	 */
22  	public Map<String, TypeData> readTypes() throws IOException;
23  
24  	/***
25  	 * Metoda dodaje dane do zbioru zarejestrowanych typów.
26  	 * 
27  	 * @param typeData -
28  	 *            dane do dodania
29  	 * @return - <code>true</code> jeśli operacja się udała (nie było
30  	 *         zarejestrowanego typu o podanej nazwie) lub <code>false</code>
31  	 *         w przeciwnym wypadku.
32  	 * @throws IOException -
33  	 *             wyjątek rzucany w przypadku błędu zapisu
34  	 */
35  	public boolean addNewType(TypeData typeData) throws IOException;
36  
37  	/***
38  	 * Metoda usuwa dane ze zbioru zarejestrowanych typów.
39  	 * 
40  	 * @param name -
41  	 *            nazwa typu do usunięcia
42  	 * @param types -
43  	 *            aktualna mapa typów (z której również zostanie typ usunięty)
44  	 * @return - <code>true</code> jeśli operacja się udała (był
45  	 *         zarejestrowany typ o podanej nazwie) lub <code>false</code> w
46  	 *         przeciwnym wypadku.
47  	 * @throws IOException -
48  	 *             wyjątek rzucany w przypadku błędu zapisu
49  	 */
50  	public boolean removeType(String name, Map<String, TypeData> types)
51  			throws IOException;
52  
53  }