summaryrefslogtreecommitdiffstats
path: root/logo/src/xlogo/interfaces/BasicFileContainer.java
blob: c648c7952361b0f9ecea401c6417a6a5ad97773e (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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
/* XLogo4Schools - A Logo Interpreter specialized for use in schools, based on XLogo by Loic Le Coq
 * Copyright (C) 2013 Marko Zivkovic
 * 
 * Contact Information: marko88zivkovic at gmail dot com
 * 
 * This program is free software; you can redistribute it and/or modify it 
 * under the terms of the GNU General Public License as published by the Free 
 * Software Foundation; either version 2 of the License, or (at your option) 
 * any later version.  This program is distributed in the hope that it will be 
 * useful, but WITHOUT ANY WARRANTY; without even the implied warranty of 
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General 
 * Public License for more details.  You should have received a copy of the 
 * GNU General Public License along with this program; if not, write to the Free 
 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 
 * MA 02110-1301, USA.
 * 
 * 
 * This Java source code belongs to XLogo4Schools, written by Marko Zivkovic
 * during his Bachelor thesis at the computer science department of ETH Zurich,
 * in the year 2013 and/or during future work.
 * 
 * It is a reengineered version of XLogo written by Loic Le Coq, published
 * under the GPL License at http://xlogo.tuxfamily.org/
 * 
 * Contents of this file were entirely written by Marko Zivkovic
 */

package xlogo.interfaces;

import java.io.File;
import java.io.IOException;

public interface BasicFileContainer
{	
	public String[] getFileNames();
	
	public String readFile(String name); // Content

	public String getLastEditedFileName();

	public void createFile(String fileName) throws IOException;
	
	public String makeUniqueFileName(String base);
	
	public boolean existsFile(String name);
	
	public void writeFileText(String fileName, String content) throws IOException;
	
	public void storeFile(String fileName) throws IOException;
	
	public void importFile(File filePath) throws IOException;
	
	public void exportFile(String fileName, File dest) throws IOException;
	
	public void exportFile(String fileName, File location, String targetName) throws IOException;
	
	public void renameFile(String oldName, String newName);

	public void removeFile(String fileName);
	
	public void eraseAll();	
	
	public void openFile(String fileName);
	
	public void closeFile(String fileName);
	
	public String getOpenFileName();
	
	public boolean isFilesListEditable();
	
	public boolean hasTooManyEmptyFiles();

	//public boolean hasErrors(String fileName);

	public void addFileListener(FileContainerChangeListener listener);
	
	public void removeFileListener(FileContainerChangeListener listener);
	
	public interface FileContainerChangeListener
	{	
		/**
		 * After the file has been opened
		 * @param file name
		 */
		public void fileOpened(String file);
		
		/**
		 * After the file has been closed
		 * @param file name
		 */
		public void fileClosed(String file);
		
		/**
		 * After the file has been added
		 * @param file name
		 */
		public void fileAdded(String file);
		
		/**
		 * After the file has been removed
		 * @param file name
		 */
		public void fileRemoved(String file);
		
		/**
		 * After a file has been renamed
		 * @param oldName
		 * @param newName
		 */
		public void fileRenamed(String oldName, String newName);
		
		/**
		 * Applies to the whole container.
		 * @param editEnabled
		 */
		public void editRightsChanged(boolean editEnabled);
		
		/**
		 * After a file is updated,
		 * or after a context switch.
		 * @param fileName
		 */
		//public void errorsDetected(String fileName);
		
		/**
		 * Only fired if errors existed before a file was updated.
		 * @param fileName
		 */
		//public void errorsCorrected(String fileName);
	}
}