Class IO

src/main/java/fieldbox/io/IO.java:37–965

This class handles the persistence of Box graphs to disk. Key design challenge here is to allow individual properties of boxes to exist as separate files on disk if it makes sense to do so (for example disparate pieces of source code), and otherwise have properties associated with a box bound up in

 * documents was therefore completely impossible. This structure will give us the ability to drag and drop documents into the Field window and save side-car .box files next to them that contain the
 * properties.
 * <p>
 * .box (the properties) and .field2 (the master document) files are stored as EDN files (see EDN.java for specifics).
 */
public class IO {
	static public final String WORKSPACE = "{{workspace}}";
	static public final String EXECUTION = "{{execution}}";
	static public final String TEMPLATES = "{{templates}}";

	public static final Dict.Prop<String> id = new Dict.Prop<>("__id__").autoConstructs(() -> Box.newID());
	public static final Dict.Prop<String> desiredBoxClass = new Dict.Prop<>("__desiredBoxClass__");
	public static final Dict.Prop<String> comment = new Dict.Prop<>("comment").toCanon()
		.type()
		.doc("A comment string that's easily searchable. Set it to provide comments on boxes used in templates.");

	public static final Dict.Prop<String> language = new Dict.Prop<>("language").toCanon()
		.type()
		.doc("marks a property's editable (CodeMirror) language")
		.set(Dict.domain, "*/attributes");
	public static final Dict.Prop<Boolean> persistent = new Dict.Prop<>("persistent").toCanon()
		.type()
		.doc("marks a property as being saved to disk")
		.set(Dict.domain, "*/attributes");
	public static final Dict.Prop<Boolean> perDocument = new Dict.Prop<>("perDocument").toCanon()
		.type()
		.doc("marks a property as being saved, conceptually, with the document rather than with the box (which might be shared between documents).")
		.set(Dict.domain, "*/attributes");
	public static final Dict.Prop<Boolean> dontCopy = new Dict.Prop<>("dontCopy").toCanon()
		.type()
		.doc("marks a property as not being copyable between boxes.")
		.set(Dict.domain, "*/attributes");

	public static final Dict.Prop<List<String>> classpath = new Dict.Prop<>("classpath").toCanon()
		.type()
		.doc("This box asks the classloader to extend the classpath by this list of paths");

	public static final Dict.Prop<IdempotencyMap<Runnable>> onPreparingToSave = new Dict.Prop<>("onPreparingToSave").toCanon()
		.type()
		.doc("Notification that this box is going to be saved to disk");
	public static final Dict.Prop<IdempotencyMap<Runnable>> onFinishingSaving = new Dict.Prop<>("onFinishingSaving").toCanon()
		.type()
		.doc("Notification that this box is going to be saved to disk");


	static Set<String> knownProperties = new LinkedHashSet<String>();
	static Map<String, Filespec> knownFiles = new HashMap<String, Filespec>();

	static {
		persist(id);
		persist(comment);
		persist(classpath);
		persist(perDocument);
	}

	private String defaultDirectory;
	private String templateDirectory;


	boolean lastWasNew = false;