Dave Jarvis' Repositories

Home Files Commits Tags

Repository:

D CHANGES.md

 # Change Log
 ## 0.9
 - Associate variable name injector with all tabs.
 ## 0.8
 - Load YAML variables from files
 - Upgraded to Apache Commons Configuration 2.1
 - Fixed bug with settings using comma-separated file extensions
 ## 0.7
 - Added cursor to the preview pane
 - Reconfigured constants to use settings
 - Organized MainWindow code by similar method calls
 - Added single entry point for refreshing file editor tab
 ## 0.6
 - Revised synchronized scrolling with preview panel
 - Added universal character encoding detection
 - Removed options panel
 - Decoupled Editor Tab and Preview Pane
 ## 0.5
 - Added document processors for Markdown and Variables
 - Simplified code base
 - Added `Ctrl+Space` hot key for quick variable injection
 - Replaced commonmark-java with flexmark
 - Insert `CARETPOSITION` into document for preview pane scroll position reference
 ## 0.4
 - Changed name to Scrivenvar
 - Added hot-keys for variable mode and autocomplete
 - Replaced pegdown with commonmark-java
 - Started document processors to provide XSLT and variable dereferencing
 ## 0.3
 - Changed name to Scrivendor
 - Changed logo to match
 - Started to implement service-oriented architecture
 ## 0.2
 - RichTextFX (and dependencies) updated to version 0.6.10 (fixes bugs)
 - pegdown Markdown parser updated to version 1.6
 - Added five new pegdown 1.6 extension flags to Markdown Options tab
 - Minor improvements
 ## 0.1
 - Initial release

M build.gradle

 version = '1.0.2'
 version = '1.0.3'
 apply plugin: 'java'

M src/main/java/com/scrivenvar/MainWindow.java

 import static com.scrivenvar.Constants.*;
 import static com.scrivenvar.Messages.get;
 import com.scrivenvar.definition.DefinitionFactory;
 import com.scrivenvar.definition.DefinitionPane;
 import com.scrivenvar.definition.DefinitionSource;
 import com.scrivenvar.definition.EmptyDefinitionSource;
 import com.scrivenvar.editors.EditorPane;
 import com.scrivenvar.editors.VariableNameInjector;
 import com.scrivenvar.editors.markdown.MarkdownEditorPane;
 import com.scrivenvar.preview.HTMLPreviewPane;
 import com.scrivenvar.processors.Processor;
 import com.scrivenvar.processors.ProcessorFactory;
 import com.scrivenvar.service.Options;
 import com.scrivenvar.service.Snitch;
 import com.scrivenvar.util.Action;
 import com.scrivenvar.util.ActionUtils;
 import static com.scrivenvar.util.StageState.*;
 import static de.jensd.fx.glyphs.fontawesome.FontAwesomeIcon.*;
 import java.net.MalformedURLException;
 import java.nio.file.Path;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Observable;
 import java.util.Observer;
 import java.util.function.Function;
 import java.util.prefs.Preferences;
 import javafx.application.Platform;
 import javafx.beans.binding.Bindings;
 import javafx.beans.binding.BooleanBinding;
 import javafx.beans.property.BooleanProperty;
 import javafx.beans.property.SimpleBooleanProperty;
 import javafx.beans.value.ObservableBooleanValue;
 import javafx.beans.value.ObservableValue;
 import javafx.collections.ListChangeListener.Change;
 import javafx.collections.ObservableList;
 import static javafx.event.Event.fireEvent;
 import javafx.scene.Node;
 import javafx.scene.Scene;
 import javafx.scene.control.Alert;
 import javafx.scene.control.Alert.AlertType;
 import javafx.scene.control.Menu;
 import javafx.scene.control.MenuBar;
 import javafx.scene.control.SplitPane;
 import javafx.scene.control.Tab;
 import javafx.scene.control.ToolBar;
 import javafx.scene.control.TreeView;
 import javafx.scene.image.Image;
 import javafx.scene.image.ImageView;
 import static javafx.scene.input.KeyCode.ESCAPE;
 import javafx.scene.input.KeyEvent;
 import static javafx.scene.input.KeyEvent.CHAR_UNDEFINED;
 import static javafx.scene.input.KeyEvent.KEY_PRESSED;
 import javafx.scene.layout.BorderPane;
 import javafx.scene.layout.VBox;
 import javafx.stage.Window;
 import javafx.stage.WindowEvent;
 import static javafx.stage.WindowEvent.WINDOW_CLOSE_REQUEST;
 /**
  * Main window containing a tab pane in the center for file editors.
+ *
  * @author Karl Tauber and White Magic Software, Ltd.
  */
 public class MainWindow implements Observer {
   private final Options options = Services.load( Options.class );
   private final Snitch snitch = Services.load( Snitch.class );
   private Scene scene;
   private MenuBar menuBar;
   private DefinitionSource definitionSource;
   private DefinitionPane definitionPane;
   private FileEditorTabPane fileEditorPane;
   private HTMLPreviewPane previewPane;
   /**
    * Prevent re-instantiation processing classes.
    */
   private Map<FileEditorTab, Processor<String>> processors;
   private ProcessorFactory processorFactory;
   public MainWindow() {
     initLayout();
     initOpenDefinitionListener();
     initTabAddedListener();
     initTabChangedListener();
     initPreferences();
     initWatchDog();
+  }
   /**
    * Listen for file editor tab pane to receive an open definition source event.
    */
   private void initOpenDefinitionListener() {
     getFileEditorPane().onOpenDefinitionFileProperty().addListener(
       (ObservableValue<? extends Path> definitionFile,
         final Path oldPath, final Path newPath) -> {
         openDefinition( newPath );
         refreshSelectedTab( getActiveFileEditor() );
       } );
+  }
   /**
    * When tabs are added, hook the various change listeners onto the new tab so
    * that the preview pane refreshes as necessary.
    */
   private void initTabAddedListener() {
     final FileEditorTabPane editorPane = getFileEditorPane();
     // Make sure the text processor kicks off when new files are opened.
     final ObservableList<Tab> tabs = editorPane.getTabs();
     // Update the preview pane on tab changes.
     tabs.addListener(
       (final Change<? extends Tab> change) -> {
         while( change.next() ) {
           if( change.wasAdded() ) {
             // Multiple tabs can be added simultaneously.
             for( final Tab newTab : change.getAddedSubList() ) {
               final FileEditorTab tab = (FileEditorTab)newTab;
               initTextChangeListener( tab );
               initCaretParagraphListener( tab );
               initVariableNameInjector( tab );
+            }
+          }
+        }
+      }
     );
+  }
   /**
    * Reloads the preferences from the previous load.
    */
   private void initPreferences() {
     getFileEditorPane().restorePreferences();
     restoreDefinitionSource();
+  }
   /**
    * Listen for new tab selection events.
    */
   private void initTabChangedListener() {
     final FileEditorTabPane editorPane = getFileEditorPane();
     // Update the preview pane changing tabs.
     editorPane.addTabSelectionListener(
       (ObservableValue<? extends Tab> tabPane,
         final Tab oldTab, final Tab newTab) -> {
         // If there was no old tab, then this is a first time load, which
         // can be ignored.
         if( oldTab != null ) {
           if( newTab == null ) {
             closeRemainingTab();
           } else {
             // Update the preview with the edited text.
             refreshSelectedTab( (FileEditorTab)newTab );
+          }
+        }
+      }
     );
+  }
   private void initTextChangeListener( final FileEditorTab tab ) {
     tab.addTextChangeListener(
       (ObservableValue<? extends String> editor,
         final String oldValue, final String newValue) -> {
         refreshSelectedTab( tab );
+      }
     );
+  }
   private void initCaretParagraphListener( final FileEditorTab tab ) {
     tab.addCaretParagraphListener(
       (ObservableValue<? extends Integer> editor,
         final Integer oldValue, final Integer newValue) -> {
         refreshSelectedTab( tab );
+      }
     );
+  }
   private void initVariableNameInjector( final FileEditorTab tab ) {
     VariableNameInjector.listen( tab, getDefinitionPane() );
+  }
   private void initWatchDog() {
     getSnitch().addObserver( this );
+  }
   /**
    * Called whenever the preview pane becomes out of sync with the file editor
    * tab. This can be called when the text changes, the caret paragraph changes,
    * or the file tab changes.
+   *
    * @param tab The file editor tab that has been changed in some fashion.
    */
   private void refreshSelectedTab( final FileEditorTab tab ) {
     getPreviewPane().setPath( tab.getPath() );
     Processor<String> processor = getProcessors().get( tab );
     if( processor == null ) {
       processor = createProcessor( tab );
       getProcessors().put( tab, processor );
+    }
     processor.processChain( tab.getEditorText() );
+  }
   /**
    * Returns the variable map of interpolated definitions.
+   *
    * @return A map to help dereference variables.
    */
   private Map<String, String> getResolvedMap() {
     return getDefinitionSource().getResolvedMap();
+  }
   /**
    * Returns the root node for the hierarchical definition source.
+   *
    * @return Data to display in the definition pane.
    */
   private TreeView<String> getTreeView() {
     try {
       return getDefinitionSource().asTreeView();
     } catch( Exception e ) {
       alert( e );
+    }
     return new TreeView<>();
+  }
   private void openDefinition( final Path path ) {
     openDefinition( path.toString() );
+  }
   private void openDefinition( final String path ) {
     try {
       final DefinitionSource ds = createDefinitionSource( path );
       setDefinitionSource( ds );
       storeDefinitionSource();
       getDefinitionPane().setRoot( ds.asTreeView() );
     } catch( Exception e ) {
       alert( e );
+    }
+  }
   private void restoreDefinitionSource() {
     final Preferences preferences = getPreferences();
     final String source = preferences.get( PREFS_DEFINITION_SOURCE, null );
     if( source != null ) {
       openDefinition( source );
+    }
+  }
   private void storeDefinitionSource() {
     final Preferences preferences = getPreferences();
     final DefinitionSource ds = getDefinitionSource();
     preferences.put( PREFS_DEFINITION_SOURCE, ds.toString() );
+  }
   /**
    * Called when the last open tab is closed. This clears out the preview pane
    * and the definition pane.
    */
   private void closeRemainingTab() {
     getPreviewPane().clear();
     getDefinitionPane().clear();
+  }
   /**
    * Called when an exception occurs that warrants the user's attention.
+   *
    * @param e The exception with a message that the user should know about.
    */
   private void alert( final Exception e ) {
     // TODO: Update the status bar.
+  }
   //---- File actions -------------------------------------------------------
   /**
    * Called when a file has been modified.
+   *
    * @param snitch The watchdog file monitoring instance.
    * @param file The file that was modified.
    */
   @Override
   public void update( final Observable snitch, final Object file ) {
     if( file instanceof Path ) {
       update( (Path)file );
+    }
+  }
   /**
    * Called when a file has been modified.
+   *
    * @param file Path to the modified file.
    */
   private void update( final Path file ) {
     // Avoid throwing IllegalStateException by running from a non-JavaFX thread.
     Platform.runLater(
       () -> {
         // Brute-force XSLT file reload by re-instantiating all processors.
         getProcessors().clear();
         refreshSelectedTab( getActiveFileEditor() );
+      }
     );
+  }
   //---- File actions -------------------------------------------------------
   private void fileNew() {
     getFileEditorPane().newEditor();
+  }
   private void fileOpen() {
     getFileEditorPane().openFileDialog();
+  }
   private void fileClose() {
     getFileEditorPane().closeEditor( getActiveFileEditor(), true );
+  }
   private void fileCloseAll() {
     getFileEditorPane().closeAllEditors();
+  }
   private void fileSave() {
     getFileEditorPane().saveEditor( getActiveFileEditor() );
+  }
   private void fileSaveAll() {
     getFileEditorPane().saveAllEditors();
+  }
   private void fileExit() {
     final Window window = getWindow();
     fireEvent( window, new WindowEvent( window, WINDOW_CLOSE_REQUEST ) );
+  }
   //---- Help actions -------------------------------------------------------
   private void helpAbout() {
     Alert alert = new Alert( AlertType.INFORMATION );
     alert.setTitle( get( "Dialog.about.title" ) );
     alert.setHeaderText( get( "Dialog.about.header" ) );
     alert.setContentText( get( "Dialog.about.content" ) );
     alert.setGraphic( new ImageView( new Image( FILE_LOGO_32 ) ) );
     alert.initOwner( getWindow() );
     alert.showAndWait();
+  }
   //---- Convenience accessors ----------------------------------------------
   private float getFloat( final String key, final float defaultValue ) {
     return getPreferences().getFloat( key, defaultValue );
+  }
   private Preferences getPreferences() {
     return getOptions().getState();
+  }
   private Window getWindow() {
     return getScene().getWindow();
+  }
   private MarkdownEditorPane getActiveEditor() {
     final EditorPane pane = getActiveFileEditor().getEditorPane();
     return pane instanceof MarkdownEditorPane ? (MarkdownEditorPane)pane : null;
+  }
   private FileEditorTab getActiveFileEditor() {
     return getFileEditorPane().getActiveFileEditor();
+  }
   //---- Member accessors ---------------------------------------------------
   public Scene getScene() {
     return this.scene;
+  }
   private void setScene( Scene scene ) {
     this.scene = scene;
+  }
   private Map<FileEditorTab, Processor<String>> getProcessors() {
     if( this.processors == null ) {
       this.processors = new HashMap<>();
+    }
     return this.processors;
+  }
   private ProcessorFactory getProcessorFactory() {
     if( this.processorFactory == null ) {
       this.processorFactory = createProcessorFactory();
+    }
     return this.processorFactory;
+  }
   private FileEditorTabPane getFileEditorPane() {
     if( this.fileEditorPane == null ) {
       this.fileEditorPane = createFileEditorPane();
+    }
     return this.fileEditorPane;
+  }
   private HTMLPreviewPane getPreviewPane() {
     if( this.previewPane == null ) {
       this.previewPane = createPreviewPane();
+    }
     return this.previewPane;
+  }
   private void setDefinitionSource( final DefinitionSource definitionSource ) {
     this.definitionSource = definitionSource;
+  }
   private DefinitionSource getDefinitionSource() {
     if( this.definitionSource == null ) {
       this.definitionSource = new EmptyDefinitionSource();
+    }
     return this.definitionSource;
+  }
   private DefinitionPane getDefinitionPane() {
     if( this.definitionPane == null ) {
       this.definitionPane = createDefinitionPane();
+    }
     return this.definitionPane;
+  }
   private Options getOptions() {
     return this.options;
+  }
   private Snitch getSnitch() {
     return this.snitch;
+  }
   public MenuBar getMenuBar() {
     return this.menuBar;
+  }
   public void setMenuBar( MenuBar menuBar ) {
     this.menuBar = menuBar;
+  }
   //---- Member creators ----------------------------------------------------
   /**
    * Factory to create processors that are suited to different file types.
+   *
    * @param tab The tab that is subjected to processing.
+   *
    * @return A processor suited to the file type specified by the tab's path.
    */
   private Processor<String> createProcessor( final FileEditorTab tab ) {
     return getProcessorFactory().createProcessor( tab );
+  }
   private ProcessorFactory createProcessorFactory() {
     return new ProcessorFactory( getPreviewPane(), getResolvedMap() );
+  }
   private DefinitionSource createDefinitionSource( final String path )
     throws MalformedURLException {
     return createDefinitionFactory().createDefinitionSource( path );
+  }
   /**
    * Create an editor pane to hold file editor tabs.
+   *
    * @return A new instance, never null.
    */
   private FileEditorTabPane createFileEditorPane() {
     return new FileEditorTabPane();
+  }
   private HTMLPreviewPane createPreviewPane() {
     return new HTMLPreviewPane();
+  }
   private DefinitionPane createDefinitionPane() {
     return new DefinitionPane( getTreeView() );
+  }
   private DefinitionFactory createDefinitionFactory() {
     return new DefinitionFactory();
+  }
   private Node createMenuBar() {
     final BooleanBinding activeFileEditorIsNull = getFileEditorPane().activeFileEditorProperty().isNull();
     // File actions
     Action fileNewAction = new Action( get( "Main.menu.file.new" ), "Shortcut+N", FILE_ALT, e -> fileNew() );
     Action fileOpenAction = new Action( get( "Main.menu.file.open" ), "Shortcut+O", FOLDER_OPEN_ALT, e -> fileOpen() );
     Action fileCloseAction = new Action( get( "Main.menu.file.close" ), "Shortcut+W", null, e -> fileClose(), activeFileEditorIsNull );
     Action fileCloseAllAction = new Action( get( "Main.menu.file.close_all" ), null, null, e -> fileCloseAll(), activeFileEditorIsNull );
     Action fileSaveAction = new Action( get( "Main.menu.file.save" ), "Shortcut+S", FLOPPY_ALT, e -> fileSave(),
       createActiveBooleanProperty( FileEditorTab::modifiedProperty ).not() );
     Action fileSaveAllAction = new Action( get( "Main.menu.file.save_all" ), "Shortcut+Shift+S", null, e -> fileSaveAll(),
       Bindings.not( getFileEditorPane().anyFileEditorModifiedProperty() ) );
     Action fileExitAction = new Action( get( "Main.menu.file.exit" ), null, null, e -> fileExit() );
     // Edit actions
     Action editUndoAction = new Action( get( "Main.menu.edit.undo" ), "Shortcut+Z", UNDO,
       e -> getActiveEditor().undo(),
       createActiveBooleanProperty( FileEditorTab::canUndoProperty ).not() );
     Action editRedoAction = new Action( get( "Main.menu.edit.redo" ), "Shortcut+Y", REPEAT,
       e -> getActiveEditor().redo(),
       createActiveBooleanProperty( FileEditorTab::canRedoProperty ).not() );
     // Insert actions
     Action insertBoldAction = new Action( get( "Main.menu.insert.bold" ), "Shortcut+B", BOLD,
       e -> getActiveEditor().surroundSelection( "**", "**" ),
       activeFileEditorIsNull );
     Action insertItalicAction = new Action( get( "Main.menu.insert.italic" ), "Shortcut+I", ITALIC,
       e -> getActiveEditor().surroundSelection( "*", "*" ),
       activeFileEditorIsNull );
     Action insertStrikethroughAction = new Action( get( "Main.menu.insert.strikethrough" ), "Shortcut+T", STRIKETHROUGH,
       e -> getActiveEditor().surroundSelection( "~~", "~~" ),
       activeFileEditorIsNull );
     Action insertBlockquoteAction = new Action( get( "Main.menu.insert.blockquote" ), "Ctrl+Q", QUOTE_LEFT, // not Shortcut+Q because of conflict on Mac
       e -> getActiveEditor().surroundSelection( "\n\n> ", "" ),
       activeFileEditorIsNull );
     Action insertCodeAction = new Action( get( "Main.menu.insert.code" ), "Shortcut+K", CODE,
       e -> getActiveEditor().surroundSelection( "`", "`" ),
       activeFileEditorIsNull );
     Action insertFencedCodeBlockAction = new Action( get( "Main.menu.insert.fenced_code_block" ), "Shortcut+Shift+K", FILE_CODE_ALT,
       e -> getActiveEditor().surroundSelection( "\n\n```\n", "\n```\n\n", get( "Main.menu.insert.fenced_code_block.prompt" ) ),
       activeFileEditorIsNull );
     Action insertLinkAction = new Action( get( "Main.menu.insert.link" ), "Shortcut+L", LINK,
       e -> getActiveEditor().insertLink(),
       activeFileEditorIsNull );
     Action insertImageAction = new Action( get( "Main.menu.insert.image" ), "Shortcut+G", PICTURE_ALT,
       e -> getActiveEditor().insertImage(),
       activeFileEditorIsNull );
     final Action[] headers = new Action[ 6 ];
     // Insert header actions (H1 ... H6)
     for( int i = 1; i <= 6; i++ ) {
       final String hashes = new String( new char[ i ] ).replace( "\0", "#" );
       final String markup = String.format( "%n%n%s ", hashes );
       final String text = get( "Main.menu.insert.header_" + i );
       final String accelerator = "Shortcut+" + i;
       final String prompt = get( "Main.menu.insert.header_" + i + ".prompt" );
       headers[ i - 1 ] = new Action( text, accelerator, HEADER,
         e -> getActiveEditor().surroundSelection( markup, "", prompt ),
         activeFileEditorIsNull );
+    }
     Action insertUnorderedListAction = new Action( get( "Main.menu.insert.unordered_list" ), "Shortcut+U", LIST_UL,
       e -> getActiveEditor().surroundSelection( "\n\n* ", "" ),
       activeFileEditorIsNull );
     Action insertOrderedListAction = new Action( get( "Main.menu.insert.ordered_list" ), "Shortcut+Shift+O", LIST_OL,
       e -> getActiveEditor().surroundSelection( "\n\n1. ", "" ),
       activeFileEditorIsNull );
     Action insertHorizontalRuleAction = new Action( get( "Main.menu.insert.horizontal_rule" ), "Shortcut+H", null,
       e -> getActiveEditor().surroundSelection( "\n\n---\n\n", "" ),
       activeFileEditorIsNull );
     // Help actions
     Action helpAboutAction = new Action( get( "Main.menu.help.about" ), null, null, e -> helpAbout() );
     //---- MenuBar ----
     Menu fileMenu = ActionUtils.createMenu( get( "Main.menu.file" ),
       fileNewAction,
       fileOpenAction,
       null,
       fileCloseAction,
       fileCloseAllAction,
       null,
       fileSaveAction,
       fileSaveAllAction,
       null,
       fileExitAction );
     Menu editMenu = ActionUtils.createMenu( get( "Main.menu.edit" ),
       editUndoAction,
       editRedoAction );
     Menu insertMenu = ActionUtils.createMenu( get( "Main.menu.insert" ),
       insertBoldAction,
       insertItalicAction,
       insertStrikethroughAction,
       insertBlockquoteAction,
       insertCodeAction,
       insertFencedCodeBlockAction,
       null,
       insertLinkAction,
       insertImageAction,
       null,
       headers[ 0 ],
       headers[ 1 ],
       headers[ 2 ],
       headers[ 3 ],
       headers[ 4 ],
       headers[ 5 ],
       null,
       insertUnorderedListAction,
       insertOrderedListAction,
       insertHorizontalRuleAction );
     Menu helpMenu = ActionUtils.createMenu( get( "Main.menu.help" ),
       helpAboutAction );
     menuBar = new MenuBar( fileMenu, editMenu, insertMenu, helpMenu );
     //---- ToolBar ----
     ToolBar toolBar = ActionUtils.createToolBar(
       fileNewAction,
       fileOpenAction,
       fileSaveAction,
       null,
       editUndoAction,
       editRedoAction,
       null,
       insertBoldAction,
       insertItalicAction,
       insertBlockquoteAction,
       insertCodeAction,
       insertFencedCodeBlockAction,
       null,
       insertLinkAction,
       insertImageAction,
       null,
       headers[ 0 ],
       null,
       insertUnorderedListAction,
       insertOrderedListAction );
     return new VBox( menuBar, toolBar );
+  }
   /**
    * Creates a boolean property that is bound to another boolean value of the
    * active editor.
    */
   private BooleanProperty createActiveBooleanProperty(
     final Function<FileEditorTab, ObservableBooleanValue> func ) {
     final BooleanProperty b = new SimpleBooleanProperty();
     final FileEditorTab tab = getActiveFileEditor();
     if( tab != null ) {
       b.bind( func.apply( tab ) );
+    }
     getFileEditorPane().activeFileEditorProperty().addListener(
       (observable, oldFileEditor, newFileEditor) -> {
         b.unbind();
         if( newFileEditor != null ) {
           b.bind( func.apply( newFileEditor ) );
         } else {
           b.set( false );
+        }
+      }
     );
     return b;
+  }
   private void initLayout() {
     final SplitPane splitPane = new SplitPane(
       getDefinitionPane().getNode(),
       getFileEditorPane().getNode(),
       getPreviewPane().getNode() );
     splitPane.setDividerPositions(
       getFloat( K_PANE_SPLIT_DEFINITION, .10f ),
       getFloat( K_PANE_SPLIT_EDITOR, .45f ),
       getFloat( K_PANE_SPLIT_PREVIEW, .45f ) );
     // See: http://broadlyapplicable.blogspot.ca/2015/03/javafx-capture-restorePreferences-splitpane.html
     final BorderPane borderPane = new BorderPane();
     borderPane.setPrefSize( 1024, 800 );
     borderPane.setTop( createMenuBar() );
     borderPane.setCenter( splitPane );
 import com.scrivenvar.definition.*;
 import com.scrivenvar.editors.EditorPane;
 import com.scrivenvar.editors.VariableNameInjector;
 import com.scrivenvar.editors.markdown.MarkdownEditorPane;
 import com.scrivenvar.preview.HTMLPreviewPane;
 import com.scrivenvar.processors.Processor;
 import com.scrivenvar.processors.ProcessorFactory;
 import com.scrivenvar.service.Options;
 import com.scrivenvar.service.Snitch;
 import com.scrivenvar.util.Action;
 import com.scrivenvar.util.ActionUtils;
 import static com.scrivenvar.util.StageState.*;
 import static de.jensd.fx.glyphs.fontawesome.FontAwesomeIcon.*;
 import java.nio.file.Path;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Observable;
 import java.util.Observer;
 import java.util.function.Function;
 import java.util.prefs.Preferences;
 import javafx.application.Platform;
 import javafx.beans.binding.Bindings;
 import javafx.beans.binding.BooleanBinding;
 import javafx.beans.property.BooleanProperty;
 import javafx.beans.property.SimpleBooleanProperty;
 import javafx.beans.value.ObservableBooleanValue;
 import javafx.beans.value.ObservableValue;
 import javafx.collections.ListChangeListener.Change;
 import javafx.collections.ObservableList;
 import static javafx.event.Event.fireEvent;
 import javafx.scene.Node;
 import javafx.scene.Scene;
 import javafx.scene.control.Alert;
 import javafx.scene.control.Alert.AlertType;
 import javafx.scene.control.Menu;
 import javafx.scene.control.MenuBar;
 import javafx.scene.control.SplitPane;
 import javafx.scene.control.Tab;
 import javafx.scene.control.ToolBar;
 import javafx.scene.control.TreeView;
 import javafx.scene.image.Image;
 import javafx.scene.image.ImageView;
 import static javafx.scene.input.KeyCode.ESCAPE;
 import javafx.scene.input.KeyEvent;
 import static javafx.scene.input.KeyEvent.CHAR_UNDEFINED;
 import static javafx.scene.input.KeyEvent.KEY_PRESSED;
 import javafx.scene.layout.BorderPane;
 import javafx.scene.layout.VBox;
 import javafx.stage.Window;
 import javafx.stage.WindowEvent;
 import static javafx.stage.WindowEvent.WINDOW_CLOSE_REQUEST;
 /**
  * Main window containing a tab pane in the center for file editors.
+ *
  * @author Karl Tauber and White Magic Software, Ltd.
  */
 public class MainWindow implements Observer {
   private final Options options = Services.load( Options.class );
   private final Snitch snitch = Services.load( Snitch.class );
   private Scene scene;
   private MenuBar menuBar;
   private DefinitionSource definitionSource;
   private DefinitionPane definitionPane;
   private FileEditorTabPane fileEditorPane;
   private HTMLPreviewPane previewPane;
   /**
    * Prevent re-instantiation processing classes.
    */
   private Map<FileEditorTab, Processor<String>> processors;
   public MainWindow() {
     initLayout();
     initOpenDefinitionListener();
     initTabAddedListener();
     initTabChangedListener();
     initPreferences();
     initWatchDog();
+  }
   /**
    * Listen for file editor tab pane to receive an open definition source event.
    */
   private void initOpenDefinitionListener() {
     getFileEditorPane().onOpenDefinitionFileProperty().addListener(
       (ObservableValue<? extends Path> definitionFile,
         final Path oldPath, final Path newPath) -> {
         openDefinition( newPath );
         setProcessors( null );
         refreshSelectedTab( getActiveFileEditor() );
+      }
     );
+  }
   /**
    * When tabs are added, hook the various change listeners onto the new tab so
    * that the preview pane refreshes as necessary.
    */
   private void initTabAddedListener() {
     final FileEditorTabPane editorPane = getFileEditorPane();
     // Make sure the text processor kicks off when new files are opened.
     final ObservableList<Tab> tabs = editorPane.getTabs();
     // Update the preview pane on tab changes.
     tabs.addListener(
       (final Change<? extends Tab> change) -> {
         while( change.next() ) {
           if( change.wasAdded() ) {
             // Multiple tabs can be added simultaneously.
             for( final Tab newTab : change.getAddedSubList() ) {
               final FileEditorTab tab = (FileEditorTab)newTab;
               initTextChangeListener( tab );
               initCaretParagraphListener( tab );
               initVariableNameInjector( tab );
+            }
+          }
+        }
+      }
     );
+  }
   /**
    * Reloads the preferences from the previous load.
    */
   private void initPreferences() {
     restoreDefinitionSource();
     getFileEditorPane().restorePreferences();
     updateDefinitionPane();
+  }
   /**
    * Listen for new tab selection events.
    */
   private void initTabChangedListener() {
     final FileEditorTabPane editorPane = getFileEditorPane();
     // Update the preview pane changing tabs.
     editorPane.addTabSelectionListener(
       (ObservableValue<? extends Tab> tabPane,
         final Tab oldTab, final Tab newTab) -> {
         // If there was no old tab, then this is a first time load, which
         // can be ignored.
         if( oldTab != null ) {
           if( newTab == null ) {
             closeRemainingTab();
           } else {
             // Update the preview with the edited text.
             refreshSelectedTab( (FileEditorTab)newTab );
+          }
+        }
+      }
     );
+  }
   private void initTextChangeListener( final FileEditorTab tab ) {
     tab.addTextChangeListener(
       (ObservableValue<? extends String> editor,
         final String oldValue, final String newValue) -> {
         refreshSelectedTab( tab );
+      }
     );
+  }
   private void initCaretParagraphListener( final FileEditorTab tab ) {
     tab.addCaretParagraphListener(
       (ObservableValue<? extends Integer> editor,
         final Integer oldValue, final Integer newValue) -> {
         refreshSelectedTab( tab );
+      }
     );
+  }
   private void initVariableNameInjector( final FileEditorTab tab ) {
     VariableNameInjector.listen( tab, getDefinitionPane() );
+  }
   /**
    * Watch for changes to external files. In particular, this awaits
    * modifications to any XSL files associated with XML files being edited. When
    * an XSL file is modified (external to the application), the watchdog's ears
    * perk up and the file is reloaded. This keeps the XSL transformation up to
    * date with what's on the file system.
    */
   private void initWatchDog() {
     getSnitch().addObserver( this );
+  }
   /**
    * Called whenever the preview pane becomes out of sync with the file editor
    * tab. This can be called when the text changes, the caret paragraph changes,
    * or the file tab changes.
+   *
    * @param tab The file editor tab that has been changed in some fashion.
    */
   private void refreshSelectedTab( final FileEditorTab tab ) {
     getPreviewPane().setPath( tab.getPath() );
     Processor<String> processor = getProcessors().get( tab );
     if( processor == null ) {
       processor = createProcessor( tab );
       getProcessors().put( tab, processor );
+    }
     processor.processChain( tab.getEditorText() );
+  }
   /**
    * Returns the variable map of interpolated definitions.
+   *
    * @return A map to help dereference variables.
    */
   private Map<String, String> getResolvedMap() {
     return getDefinitionSource().getResolvedMap();
+  }
   /**
    * Returns the root node for the hierarchical definition source.
+   *
    * @return Data to display in the definition pane.
    */
   private TreeView<String> getTreeView() {
     try {
       return getDefinitionSource().asTreeView();
     } catch( Exception e ) {
       alert( e );
+    }
     return new TreeView<>();
+  }
   /**
    * Called when a definition file is opened.
+   *
    * @param path Path to the file that was opened.
    */
   private void openDefinition( final Path path ) {
     openDefinition( path.toString() );
+  }
   /**
    * Called to load a definition file from its source location.
+   *
    * @param path The path to the definition file that was loaded.
    */
   private void openDefinition( final String path ) {
     try {
       final DefinitionSource ds = createDefinitionSource( path );
       setDefinitionSource( ds );
       storeDefinitionSource();
       updateDefinitionPane();
     } catch( Exception e ) {
       alert( e );
+    }
+  }
   private void updateDefinitionPane() {
     getDefinitionPane().setRoot( getDefinitionSource().asTreeView() );
+  }
   private void restoreDefinitionSource() {
     final Preferences preferences = getPreferences();
     final String source = preferences.get( PREFS_DEFINITION_SOURCE, null );
     setDefinitionSource( createDefinitionSource( source ) );
+  }
   private void storeDefinitionSource() {
     final Preferences preferences = getPreferences();
     final DefinitionSource ds = getDefinitionSource();
     preferences.put( PREFS_DEFINITION_SOURCE, ds.toString() );
+  }
   /**
    * Called when the last open tab is closed. This clears out the preview pane
    * and the definition pane.
    */
   private void closeRemainingTab() {
     getPreviewPane().clear();
     getDefinitionPane().clear();
+  }
   /**
    * Called when an exception occurs that warrants the user's attention.
+   *
    * @param e The exception with a message that the user should know about.
    */
   private void alert( final Exception e ) {
     // TODO: Update the status bar.
+  }
   //---- File actions -------------------------------------------------------
   /**
    * Called when a file has been modified.
+   *
    * @param snitch The watchdog file monitoring instance.
    * @param file The file that was modified.
    */
   @Override
   public void update( final Observable snitch, final Object file ) {
     if( file instanceof Path ) {
       update( (Path)file );
+    }
+  }
   /**
    * Called when a file has been modified.
+   *
    * @param file Path to the modified file.
    */
   private void update( final Path file ) {
     // Avoid throwing IllegalStateException by running from a non-JavaFX thread.
     Platform.runLater(
       () -> {
         // Brute-force XSLT file reload by re-instantiating all processors.
         resetProcessors();
         refreshSelectedTab( getActiveFileEditor() );
+      }
     );
+  }
   /**
    * After resetting the processors, they will refresh anew to be up-to-date
    * with the files (text and definition) currently loaded into the editor.
    */
   private void resetProcessors() {
     getProcessors().clear();
+  }
   //---- File actions -------------------------------------------------------
   private void fileNew() {
     getFileEditorPane().newEditor();
+  }
   private void fileOpen() {
     getFileEditorPane().openFileDialog();
+  }
   private void fileClose() {
     getFileEditorPane().closeEditor( getActiveFileEditor(), true );
+  }
   private void fileCloseAll() {
     getFileEditorPane().closeAllEditors();
+  }
   private void fileSave() {
     getFileEditorPane().saveEditor( getActiveFileEditor() );
+  }
   private void fileSaveAll() {
     getFileEditorPane().saveAllEditors();
+  }
   private void fileExit() {
     final Window window = getWindow();
     fireEvent( window, new WindowEvent( window, WINDOW_CLOSE_REQUEST ) );
+  }
   //---- Help actions -------------------------------------------------------
   private void helpAbout() {
     Alert alert = new Alert( AlertType.INFORMATION );
     alert.setTitle( get( "Dialog.about.title" ) );
     alert.setHeaderText( get( "Dialog.about.header" ) );
     alert.setContentText( get( "Dialog.about.content" ) );
     alert.setGraphic( new ImageView( new Image( FILE_LOGO_32 ) ) );
     alert.initOwner( getWindow() );
     alert.showAndWait();
+  }
   //---- Convenience accessors ----------------------------------------------
   private float getFloat( final String key, final float defaultValue ) {
     return getPreferences().getFloat( key, defaultValue );
+  }
   private Preferences getPreferences() {
     return getOptions().getState();
+  }
   private Window getWindow() {
     return getScene().getWindow();
+  }
   private MarkdownEditorPane getActiveEditor() {
     final EditorPane pane = getActiveFileEditor().getEditorPane();
     return pane instanceof MarkdownEditorPane ? (MarkdownEditorPane)pane : null;
+  }
   private FileEditorTab getActiveFileEditor() {
     return getFileEditorPane().getActiveFileEditor();
+  }
   //---- Member accessors ---------------------------------------------------
   private void setScene( Scene scene ) {
     this.scene = scene;
+  }
   public Scene getScene() {
     return this.scene;
+  }
   private void setProcessors( final Map<FileEditorTab, Processor<String>> map ) {
     this.processors = map;
+  }
   private Map<FileEditorTab, Processor<String>> getProcessors() {
     if( this.processors == null ) {
       setProcessors( new HashMap<>() );
+    }
     return this.processors;
+  }
   private FileEditorTabPane getFileEditorPane() {
     if( this.fileEditorPane == null ) {
       this.fileEditorPane = createFileEditorPane();
+    }
     return this.fileEditorPane;
+  }
   private HTMLPreviewPane getPreviewPane() {
     if( this.previewPane == null ) {
       this.previewPane = createPreviewPane();
+    }
     return this.previewPane;
+  }
   private void setDefinitionSource( final DefinitionSource definitionSource ) {
     this.definitionSource = definitionSource;
+  }
   private DefinitionSource getDefinitionSource() {
     if( this.definitionSource == null ) {
       this.definitionSource = new EmptyDefinitionSource();
+    }
     return this.definitionSource;
+  }
   private DefinitionPane getDefinitionPane() {
     if( this.definitionPane == null ) {
       this.definitionPane = createDefinitionPane();
+    }
     return this.definitionPane;
+  }
   private Options getOptions() {
     return this.options;
+  }
   private Snitch getSnitch() {
     return this.snitch;
+  }
   public void setMenuBar( MenuBar menuBar ) {
     this.menuBar = menuBar;
+  }
   public MenuBar getMenuBar() {
     return this.menuBar;
+  }
   //---- Member creators ----------------------------------------------------
   /**
    * Factory to create processors that are suited to different file types.
+   *
    * @param tab The tab that is subjected to processing.
+   *
    * @return A processor suited to the file type specified by the tab's path.
    */
   private Processor<String> createProcessor( final FileEditorTab tab ) {
     return createProcessorFactory().createProcessor( tab );
+  }
   private ProcessorFactory createProcessorFactory() {
     return new ProcessorFactory( getPreviewPane(), getResolvedMap() );
+  }
   private DefinitionSource createDefinitionSource( final String path ) {
     return createDefinitionFactory().createDefinitionSource( path );
+  }
   /**
    * Create an editor pane to hold file editor tabs.
+   *
    * @return A new instance, never null.
    */
   private FileEditorTabPane createFileEditorPane() {
     return new FileEditorTabPane();
+  }
   private HTMLPreviewPane createPreviewPane() {
     return new HTMLPreviewPane();
+  }
   private DefinitionPane createDefinitionPane() {
     return new DefinitionPane( getTreeView() );
+  }
   private DefinitionFactory createDefinitionFactory() {
     return new DefinitionFactory();
+  }
   private Node createMenuBar() {
     final BooleanBinding activeFileEditorIsNull = getFileEditorPane().activeFileEditorProperty().isNull();
     // File actions
     Action fileNewAction = new Action( get( "Main.menu.file.new" ), "Shortcut+N", FILE_ALT, e -> fileNew() );
     Action fileOpenAction = new Action( get( "Main.menu.file.open" ), "Shortcut+O", FOLDER_OPEN_ALT, e -> fileOpen() );
     Action fileCloseAction = new Action( get( "Main.menu.file.close" ), "Shortcut+W", null, e -> fileClose(), activeFileEditorIsNull );
     Action fileCloseAllAction = new Action( get( "Main.menu.file.close_all" ), null, null, e -> fileCloseAll(), activeFileEditorIsNull );
     Action fileSaveAction = new Action( get( "Main.menu.file.save" ), "Shortcut+S", FLOPPY_ALT, e -> fileSave(),
       createActiveBooleanProperty( FileEditorTab::modifiedProperty ).not() );
     Action fileSaveAllAction = new Action( get( "Main.menu.file.save_all" ), "Shortcut+Shift+S", null, e -> fileSaveAll(),
       Bindings.not( getFileEditorPane().anyFileEditorModifiedProperty() ) );
     Action fileExitAction = new Action( get( "Main.menu.file.exit" ), null, null, e -> fileExit() );
     // Edit actions
     Action editUndoAction = new Action( get( "Main.menu.edit.undo" ), "Shortcut+Z", UNDO,
       e -> getActiveEditor().undo(),
       createActiveBooleanProperty( FileEditorTab::canUndoProperty ).not() );
     Action editRedoAction = new Action( get( "Main.menu.edit.redo" ), "Shortcut+Y", REPEAT,
       e -> getActiveEditor().redo(),
       createActiveBooleanProperty( FileEditorTab::canRedoProperty ).not() );
     // Insert actions
     Action insertBoldAction = new Action( get( "Main.menu.insert.bold" ), "Shortcut+B", BOLD,
       e -> getActiveEditor().surroundSelection( "**", "**" ),
       activeFileEditorIsNull );
     Action insertItalicAction = new Action( get( "Main.menu.insert.italic" ), "Shortcut+I", ITALIC,
       e -> getActiveEditor().surroundSelection( "*", "*" ),
       activeFileEditorIsNull );
     Action insertStrikethroughAction = new Action( get( "Main.menu.insert.strikethrough" ), "Shortcut+T", STRIKETHROUGH,
       e -> getActiveEditor().surroundSelection( "~~", "~~" ),
       activeFileEditorIsNull );
     Action insertBlockquoteAction = new Action( get( "Main.menu.insert.blockquote" ), "Ctrl+Q", QUOTE_LEFT, // not Shortcut+Q because of conflict on Mac
       e -> getActiveEditor().surroundSelection( "\n\n> ", "" ),
       activeFileEditorIsNull );
     Action insertCodeAction = new Action( get( "Main.menu.insert.code" ), "Shortcut+K", CODE,
       e -> getActiveEditor().surroundSelection( "`", "`" ),
       activeFileEditorIsNull );
     Action insertFencedCodeBlockAction = new Action( get( "Main.menu.insert.fenced_code_block" ), "Shortcut+Shift+K", FILE_CODE_ALT,
       e -> getActiveEditor().surroundSelection( "\n\n```\n", "\n```\n\n", get( "Main.menu.insert.fenced_code_block.prompt" ) ),
       activeFileEditorIsNull );
     Action insertLinkAction = new Action( get( "Main.menu.insert.link" ), "Shortcut+L", LINK,
       e -> getActiveEditor().insertLink(),
       activeFileEditorIsNull );
     Action insertImageAction = new Action( get( "Main.menu.insert.image" ), "Shortcut+G", PICTURE_ALT,
       e -> getActiveEditor().insertImage(),
       activeFileEditorIsNull );
     final Action[] headers = new Action[ 6 ];
     // Insert header actions (H1 ... H6)
     for( int i = 1; i <= 6; i++ ) {
       final String hashes = new String( new char[ i ] ).replace( "\0", "#" );
       final String markup = String.format( "%n%n%s ", hashes );
       final String text = get( "Main.menu.insert.header_" + i );
       final String accelerator = "Shortcut+" + i;
       final String prompt = get( "Main.menu.insert.header_" + i + ".prompt" );
       headers[ i - 1 ] = new Action( text, accelerator, HEADER,
         e -> getActiveEditor().surroundSelection( markup, "", prompt ),
         activeFileEditorIsNull );
+    }
     Action insertUnorderedListAction = new Action( get( "Main.menu.insert.unordered_list" ), "Shortcut+U", LIST_UL,
       e -> getActiveEditor().surroundSelection( "\n\n* ", "" ),
       activeFileEditorIsNull );
     Action insertOrderedListAction = new Action( get( "Main.menu.insert.ordered_list" ), "Shortcut+Shift+O", LIST_OL,
       e -> getActiveEditor().surroundSelection( "\n\n1. ", "" ),
       activeFileEditorIsNull );
     Action insertHorizontalRuleAction = new Action( get( "Main.menu.insert.horizontal_rule" ), "Shortcut+H", null,
       e -> getActiveEditor().surroundSelection( "\n\n---\n\n", "" ),
       activeFileEditorIsNull );
     // Help actions
     Action helpAboutAction = new Action( get( "Main.menu.help.about" ), null, null, e -> helpAbout() );
     //---- MenuBar ----
     Menu fileMenu = ActionUtils.createMenu( get( "Main.menu.file" ),
       fileNewAction,
       fileOpenAction,
       null,
       fileCloseAction,
       fileCloseAllAction,
       null,
       fileSaveAction,
       fileSaveAllAction,
       null,
       fileExitAction );
     Menu editMenu = ActionUtils.createMenu( get( "Main.menu.edit" ),
       editUndoAction,
       editRedoAction );
     Menu insertMenu = ActionUtils.createMenu( get( "Main.menu.insert" ),
       insertBoldAction,
       insertItalicAction,
       insertStrikethroughAction,
       insertBlockquoteAction,
       insertCodeAction,
       insertFencedCodeBlockAction,
       null,
       insertLinkAction,
       insertImageAction,
       null,
       headers[ 0 ],
       headers[ 1 ],
       headers[ 2 ],
       headers[ 3 ],
       headers[ 4 ],
       headers[ 5 ],
       null,
       insertUnorderedListAction,
       insertOrderedListAction,
       insertHorizontalRuleAction );
     Menu helpMenu = ActionUtils.createMenu( get( "Main.menu.help" ),
       helpAboutAction );
     menuBar = new MenuBar( fileMenu, editMenu, insertMenu, helpMenu );
     //---- ToolBar ----
     ToolBar toolBar = ActionUtils.createToolBar(
       fileNewAction,
       fileOpenAction,
       fileSaveAction,
       null,
       editUndoAction,
       editRedoAction,
       null,
       insertBoldAction,
       insertItalicAction,
       insertBlockquoteAction,
       insertCodeAction,
       insertFencedCodeBlockAction,
       null,
       insertLinkAction,
       insertImageAction,
       null,
       headers[ 0 ],
       null,
       insertUnorderedListAction,
       insertOrderedListAction );
     return new VBox( menuBar, toolBar );
+  }
   /**
    * Creates a boolean property that is bound to another boolean value of the
    * active editor.
    */
   private BooleanProperty createActiveBooleanProperty(
     final Function<FileEditorTab, ObservableBooleanValue> func ) {
     final BooleanProperty b = new SimpleBooleanProperty();
     final FileEditorTab tab = getActiveFileEditor();
     if( tab != null ) {
       b.bind( func.apply( tab ) );
+    }
     getFileEditorPane().activeFileEditorProperty().addListener(
       (observable, oldFileEditor, newFileEditor) -> {
         b.unbind();
         if( newFileEditor != null ) {
           b.bind( func.apply( newFileEditor ) );
         } else {
           b.set( false );
+        }
+      }
     );
     return b;
+  }
   private void initLayout() {
     final SplitPane splitPane = new SplitPane(
       getDefinitionPane().getNode(),
       getFileEditorPane().getNode(),
       getPreviewPane().getNode() );
     splitPane.setDividerPositions(
       getFloat( K_PANE_SPLIT_DEFINITION, .10f ),
       getFloat( K_PANE_SPLIT_EDITOR, .45f ),
       getFloat( K_PANE_SPLIT_PREVIEW, .45f ) );
     // See: http://broadlyapplicable.blogspot.ca/2015/03/javafx-capture-restorePreferences-splitpane.html
     final BorderPane borderPane = new BorderPane();
     borderPane.setPrefSize( 1024, 800 );
     borderPane.setTop( createMenuBar() );
     borderPane.setCenter( splitPane );
     final Scene appScene = new Scene( borderPane );
     setScene( appScene );

M src/main/java/com/scrivenvar/definition/DefinitionFactory.java

   /**
+   *
    * @param path
    * @param path Path to a file containing definitions.
    * @return
    */

M src/main/java/com/scrivenvar/definition/DefinitionSource.java

 package com.scrivenvar.definition;
 import java.io.IOException;
 import java.util.Map;
 import javafx.scene.control.TreeView;
+   *
    * @return A hierarchical tree suitable for displaying in the definition pane.
+   *
    * @throws IOException Could not obtain the definition source data.
    */
   public TreeView<String> asTreeView() throws IOException;
   public TreeView<String> asTreeView();
   /**
    * Must return a re-loadable path to the data source. For a file, this is the
    * absolute file path. For a database, this could be the JDBC connection. For
    * a web site, this might be the GET url.
    * a web site, this might be the GET URL.
+   *
    * @return A non-null, non-empty string.

M src/main/java/com/scrivenvar/definition/EmptyDefinitionSource.java

package com.scrivenvar.definition;

import java.io.IOException;
import java.util.HashMap;
import java.util.Map;


  @Override
  public TreeView<String> asTreeView() throws IOException {
  public TreeView<String> asTreeView() {
    return new TreeView<>();
  }

  @Override
  public Map<String, String> getResolvedMap() {
    return new HashMap<>();
  }

}


M src/main/java/com/scrivenvar/definition/yaml/YamlFileDefinitionSource.java

 import static com.scrivenvar.Messages.get;
 import java.io.IOException;
 import java.io.InputStream;
 import java.nio.file.Files;
   private YamlTreeAdapter yamlTreeAdapter;
   private YamlParser yamlParser;
   private TreeView<String> treeView;
   /**
    * Constructs a new YAML definition source, populated from the given file.
+   *
    * @param path Path to the YAML definition file.
    */
   public YamlFileDefinitionSource( final Path path ) {
     super( path );
     init();
+  }
   private void init() {
     setYamlParser( createYamlParser() );
+  }
   /**
    * TODO: Associate variable file with path to current file.
+   *
    * @return The TreeView for this definition source.
+   *
    * @throws IOException
    */
   @Override
   public TreeView<String> asTreeView() throws IOException {
     try( final InputStream in = Files.newInputStream( getPath() ) ) {
       return getYamlTreeAdapter().adapt(
         in,
         get( "Pane.defintion.node.root.title" )
       );
   public TreeView<String> asTreeView() {
     if( this.treeView == null ) {
       this.treeView = createTreeView();
+    }
     return this.treeView;
+  }
   private YamlParser getYamlParser() {
     if( this.yamlParser == null ) {
       setYamlParser( new YamlParser() );
       setYamlParser( createYamlParser() );
+    }
     return this.yamlParser;
+  }
   private void setYamlParser( final YamlParser yamlParser ) {
     this.yamlParser = yamlParser;
+  }
   private YamlParser createYamlParser() {
     try( final InputStream in = Files.newInputStream( getPath() ) ) {
       return new YamlParser( in );
     } catch( final Exception e ) {
       throw new RuntimeException( e );
+    }
+  }
   private TreeView<String> createTreeView() {
     return getYamlTreeAdapter().adapt(
       get( "Pane.defintion.node.root.title" )
     );
+  }
+}

M src/main/java/com/scrivenvar/definition/yaml/YamlParser.java

  * @author White Magic Software, Ltd.
  */
 public class YamlParser  {
   /**
    * Separates YAML variable nodes (e.g., the dots in
    * <code>$root.node.var$</code>).
    */
   public static final String SEPARATOR = ".";
   public static final char SEPARATOR_CHAR = SEPARATOR.charAt( 0 );
   private final static int GROUP_DELIMITED = 1;
   private final static int GROUP_REFERENCE = 2;
   private final static VariableDecorator VARIABLE_DECORATOR
     = new YamlVariableDecorator();
   /**
    * Compiled version of DEFAULT_REGEX.
    */
   private final static Pattern REGEX_PATTERN
     = Pattern.compile( YamlVariableDecorator.REGEX );
   /**
    * Should be JsonPointer.SEPARATOR, but Jackson YAML uses magic values.
    */
   private final static char SEPARATOR_YAML = '/';
   /**
    * Start of the Universe (the YAML document node that contains all others).
    */
   private ObjectNode documentRoot;
   /**
    * Map of references to dereferenced field values.
    */
   private Map<String, String> references;
   public YamlParser() {
+  }
   /**
    * Returns the given string with all the delimited references swapped with
    * their recursively resolved values.
+   *
    * @param text The text to parse with zero or more delimited references to
    * replace.
+   *
    * @return The substituted value.
    */
   public String substitute( String text ) {
     final Matcher matcher = patternMatch( text );
     final Map<String, String> map = getReferences();
     while( matcher.find() ) {
       final String key = matcher.group( GROUP_DELIMITED );
       final String value = map.get( key );
       if( value == null ) {
         missing( text );
       } else {
         text = text.replace( key, value );
+      }
+    }
     return text;
+  }
   /**
    * Returns all the strings with their values resolved in a flat hierarchy.
    * This copies all the keys and resolved values into a new map.
+   *
    * @return The new map created with all values having been resolved,
    * recursively.
    */
   public Map<String, String> createResolvedMap() {
     final Map<String, String> map = new HashMap<>( 1024 );
     resolve( getDocumentRoot(), "", map );
     return map;
+  }
   /**
    * Iterate over a given root node (at any level of the tree) and adapt each
    * leaf node.
+   *
    * @param rootNode A JSON node (YAML node) to adapt.
    */
   private void resolve(
     final JsonNode rootNode, final String path, final Map<String, String> map ) {
     if( rootNode != null ) {
       rootNode.fields().forEachRemaining(
         (Entry<String, JsonNode> leaf) -> resolve( leaf, path, map )
       );
+    }
+  }
   /**
    * Recursively adapt each rootNode to a corresponding rootItem.
+   *
    * @param rootNode The node to adapt.
    */
   private void resolve(
     final Entry<String, JsonNode> rootNode,
     final String path,
     final Map<String, String> map ) {
     final JsonNode leafNode = rootNode.getValue();
     final String key = rootNode.getKey();
     if( leafNode.isValueNode() ) {
       final String value = rootNode.getValue().asText();
       map.put( VARIABLE_DECORATOR.decorate( path + key ), substitute( value ) );
+    }
     if( leafNode.isObject() ) {
       resolve( leafNode, path + key + SEPARATOR, map );
+    }
+  }
   /**
    * Reads the first document from the given stream of YAML data and returns a
    * corresponding object that represents the YAML hierarchy. The calling class
    * is responsible for closing the stream. Calling classes should use
    * <code>JsonNode.fields()</code> to walk through the YAML tree of fields.
+   *
    * @param in The input stream containing YAML content.
+   *
    * @return An object hierarchy to represent the content.
+   *
    * @throws IOException Could not read the stream.
    */
   public JsonNode process( final InputStream in ) throws IOException {
     final ObjectNode root = (ObjectNode)getObjectMapper().readTree( in );
     setDocumentRoot( root );
     process( root );
     return getDocumentRoot();
+  }
   /**
    * Iterate over a given root node (at any level of the tree) and process each
    * leaf node.
+   *
    * @param root A node to process.
    */
   private void process( final JsonNode root ) {
     root.fields().forEachRemaining( this::process );
+  }
   /**
    * Process the given field, which is a named node. This is where the
    * application does the up-front work of mapping references to their fully
    * recursively dereferenced values.
+   *
    * @param field The named node.
    */
   private void process( final Entry<String, JsonNode> field ) {
     final JsonNode node = field.getValue();
     if( node.isObject() ) {
       process( node );
     } else {
       final JsonNode fieldValue = field.getValue();
       // Only basic data types can be parsed into variable values. For
       // node structures, YAML has a built-in mechanism.
       if( fieldValue.isValueNode() ) {
         try {
           resolve( fieldValue.asText() );
         } catch( StackOverflowError e ) {
           throw new IllegalArgumentException(
             "Unresolvable: " + node.textValue() + " = " + fieldValue );
+        }
+      }
+    }
+  }
   /**
    * Inserts the delimited references and field values into the cache. This will
    * overwrite existing references.
+   *
    * @param fieldValue YAML field containing zero or more delimited references.
    * If it contains a delimited reference, the parameter is modified with the
    * dereferenced value before it is returned.
+   *
    * @return fieldValue without delimited references.
    */
   private String resolve( String fieldValue ) {
     final Matcher matcher = patternMatch( fieldValue );
     while( matcher.find() ) {
       final String delimited = matcher.group( GROUP_DELIMITED );
       final String reference = matcher.group( GROUP_REFERENCE );
       final String dereference = resolve( lookup( reference ) );
       fieldValue = fieldValue.replace( delimited, dereference );
       // This will perform some superfluous calls by overwriting existing
       // items in the delimited reference map.
       put( delimited, dereference );
+    }
     return fieldValue;
+  }
   /**
    * Inserts a key/value pair into the references map. The map retains
    * references and dereferenced values found in the YAML. If the reference
    * already exists, this will overwrite with a new value.
+   *
    * @param delimited The variable name.
    * @param dereferenced The resolved value.
    */
   private void put( String delimited, String dereferenced ) {
     if( dereferenced.isEmpty() ) {
       missing( delimited );
     } else {
       getReferences().put( delimited, dereferenced );
+    }
+  }
   /**
    * Writes the modified YAML document to standard output.
    */
   private void writeDocument() throws IOException {
     getObjectMapper().writeValue( System.out, getDocumentRoot() );
+  }
   /**
    * Called when a delimited reference is dereferenced to an empty string. This
    * should produce a warning for the user.
+   *
    * @param delimited Delimited reference with no derived value.
    */
   private void missing( final String delimited ) {
     throw new InvalidParameterException(
       MessageFormat.format( "Missing value for '{0}'.", delimited ) );
+  }
   /**
    * Returns a REGEX_PATTERN matcher for the given text.
+   *
    * @param text The text that contains zero or more instances of a
    * REGEX_PATTERN that can be found using the regular expression.
    */
   private Matcher patternMatch( String text ) {
     return getPattern().matcher( text );
+  }
   /**
    * Finds the YAML value for a reference.
+   *
    * @param reference References a value in the YAML document.
+   *
    * @return The dereferenced value.
    */
   private String lookup( final String reference ) {
     return getDocumentRoot().at( asPath( reference ) ).asText();
+  }
   /**
    * Converts a reference (not delimited) to a path that can be used to find a
    * value that should exist inside the YAML document.
+   *
    * @param reference The reference to convert to a YAML document path.
+   *
    * @return The reference with a leading slash and its separator characters
    * converted to slashes.
    */
   private String asPath( final String reference ) {
     return SEPARATOR_YAML + reference.replace( getDelimitedSeparator(), SEPARATOR_YAML );
+  }
   /**
    * Sets the parent node for the entire YAML document tree.
+   *
    * @param documentRoot The parent node.
    */
   private void setDocumentRoot( ObjectNode documentRoot ) {
     this.documentRoot = documentRoot;
+  }
   /**
    * Returns the parent node for the entire YAML document tree.
+   *
    * @return The parent node.
    */
   private ObjectNode getDocumentRoot() {
     return this.documentRoot;
+  }
   /**
    * Returns the compiled regular expression REGEX_PATTERN used to match
    * delimited references.
+   *
    * @return A compiled regex for use with the Matcher.
    */
   private Pattern getPattern() {
     return REGEX_PATTERN;
+  }
   /**
    * Returns the list of references mapped to dereferenced values.
+   *
    * @return
    */
   private Map<String, String> getReferences() {
     if( this.references == null ) {
       this.references = createReferences();
+    }
     return this.references;
+  }
   /**
    * Subclasses can override this method to insert their own map.
+   *
    * @return An empty HashMap, never null.
    */
   protected Map<String, String> createReferences() {
     return new HashMap<>();
+  }
   private final class ResolverYAMLFactory extends YAMLFactory {
     private static final long serialVersionUID = 1L;
     @Override
     protected YAMLGenerator _createGenerator(
       final Writer out, final IOContext ctxt ) throws IOException {
       return new ResolverYAMLGenerator(
         ctxt, _generatorFeatures, _yamlGeneratorFeatures, _objectCodec,
         out, _version );
+    }
+  }
   private class ResolverYAMLGenerator extends YAMLGenerator {
     public ResolverYAMLGenerator(
       final IOContext ctxt,
       final int jsonFeatures,
       final int yamlFeatures,
       final ObjectCodec codec,
       final Writer out,
       final DumperOptions.Version version ) throws IOException {
       super( ctxt, jsonFeatures, yamlFeatures, codec, out, version );
+    }
     @Override
     public void writeString( final String text )
       throws IOException, JsonGenerationException {
       super.writeString( substitute( text ) );
+    }
+  }
   private YAMLFactory getYAMLFactory() {
     return new ResolverYAMLFactory();
+  }
 public class YamlParser {
   /**
    * Separates YAML variable nodes (e.g., the dots in
    * <code>$root.node.var$</code>).
    */
   public static final String SEPARATOR = ".";
   public static final char SEPARATOR_CHAR = SEPARATOR.charAt( 0 );
   private final static int GROUP_DELIMITED = 1;
   private final static int GROUP_REFERENCE = 2;
   private final static VariableDecorator VARIABLE_DECORATOR
     = new YamlVariableDecorator();
   /**
    * Compiled version of DEFAULT_REGEX.
    */
   private final static Pattern REGEX_PATTERN
     = Pattern.compile( YamlVariableDecorator.REGEX );
   /**
    * Should be JsonPointer.SEPARATOR, but Jackson YAML uses magic values.
    */
   private final static char SEPARATOR_YAML = '/';
   /**
    * Start of the Universe (the YAML document node that contains all others).
    */
   private JsonNode documentRoot;
   /**
    * Map of references to dereferenced field values.
    */
   private Map<String, String> references;
   public YamlParser( final InputStream in ) throws IOException {
     process( in );
+  }
   /**
    * Returns the given string with all the delimited references swapped with
    * their recursively resolved values.
+   *
    * @param text The text to parse with zero or more delimited references to
    * replace.
+   *
    * @return The substituted value.
    */
   public String substitute( String text ) {
     final Matcher matcher = patternMatch( text );
     final Map<String, String> map = getReferences();
     while( matcher.find() ) {
       final String key = matcher.group( GROUP_DELIMITED );
       final String value = map.get( key );
       if( value == null ) {
         missing( text );
       } else {
         text = text.replace( key, value );
+      }
+    }
     return text;
+  }
   /**
    * Returns all the strings with their values resolved in a flat hierarchy.
    * This copies all the keys and resolved values into a new map.
+   *
    * @return The new map created with all values having been resolved,
    * recursively.
    */
   public Map<String, String> createResolvedMap() {
     final Map<String, String> map = new HashMap<>( 1024 );
     resolve( getDocumentRoot(), "", map );
     return map;
+  }
   /**
    * Iterate over a given root node (at any level of the tree) and adapt each
    * leaf node.
+   *
    * @param rootNode A JSON node (YAML node) to adapt.
    * @param map Container that associates definitions with values.
    */
   private void resolve(
     final JsonNode rootNode, final String path, final Map<String, String> map ) {
     if( rootNode != null ) {
       rootNode.fields().forEachRemaining(
         (Entry<String, JsonNode> leaf) -> resolve( leaf, path, map )
       );
+    }
+  }
   /**
    * Recursively adapt each rootNode to a corresponding rootItem.
+   *
    * @param rootNode The node to adapt.
    */
   private void resolve(
     final Entry<String, JsonNode> rootNode,
     final String path,
     final Map<String, String> map ) {
     final JsonNode leafNode = rootNode.getValue();
     final String key = rootNode.getKey();
     if( leafNode.isValueNode() ) {
       final String value = rootNode.getValue().asText();
       map.put( VARIABLE_DECORATOR.decorate( path + key ), substitute( value ) );
+    }
     if( leafNode.isObject() ) {
       resolve( leafNode, path + key + SEPARATOR, map );
+    }
+  }
   /**
    * Reads the first document from the given stream of YAML data and returns a
    * corresponding object that represents the YAML hierarchy. The calling class
    * is responsible for closing the stream. Calling classes should use
    * <code>JsonNode.fields()</code> to walk through the YAML tree of fields.
+   *
    * @param in The input stream containing YAML content.
+   *
    * @return An object hierarchy to represent the content.
+   *
    * @throws IOException Could not read the stream.
    */
   private JsonNode process( final InputStream in ) throws IOException {
     final ObjectNode root = (ObjectNode)getObjectMapper().readTree( in );
     setDocumentRoot( root );
     process( root );
     return getDocumentRoot();
+  }
   /**
    * Iterate over a given root node (at any level of the tree) and process each
    * leaf node.
+   *
    * @param root A node to process.
    */
   private void process( final JsonNode root ) {
     root.fields().forEachRemaining( this::process );
+  }
   /**
    * Process the given field, which is a named node. This is where the
    * application does the up-front work of mapping references to their fully
    * recursively dereferenced values.
+   *
    * @param field The named node.
    */
   private void process( final Entry<String, JsonNode> field ) {
     final JsonNode node = field.getValue();
     if( node.isObject() ) {
       process( node );
     } else {
       final JsonNode fieldValue = field.getValue();
       // Only basic data types can be parsed into variable values. For
       // node structures, YAML has a built-in mechanism.
       if( fieldValue.isValueNode() ) {
         try {
           resolve( fieldValue.asText() );
         } catch( StackOverflowError e ) {
           throw new IllegalArgumentException(
             "Unresolvable: " + node.textValue() + " = " + fieldValue );
+        }
+      }
+    }
+  }
   /**
    * Inserts the delimited references and field values into the cache. This will
    * overwrite existing references.
+   *
    * @param fieldValue YAML field containing zero or more delimited references.
    * If it contains a delimited reference, the parameter is modified with the
    * dereferenced value before it is returned.
+   *
    * @return fieldValue without delimited references.
    */
   private String resolve( String fieldValue ) {
     final Matcher matcher = patternMatch( fieldValue );
     while( matcher.find() ) {
       final String delimited = matcher.group( GROUP_DELIMITED );
       final String reference = matcher.group( GROUP_REFERENCE );
       final String dereference = resolve( lookup( reference ) );
       fieldValue = fieldValue.replace( delimited, dereference );
       // This will perform some superfluous calls by overwriting existing
       // items in the delimited reference map.
       put( delimited, dereference );
+    }
     return fieldValue;
+  }
   /**
    * Inserts a key/value pair into the references map. The map retains
    * references and dereferenced values found in the YAML. If the reference
    * already exists, this will overwrite with a new value.
+   *
    * @param delimited The variable name.
    * @param dereferenced The resolved value.
    */
   private void put( String delimited, String dereferenced ) {
     if( dereferenced.isEmpty() ) {
       missing( delimited );
     } else {
       getReferences().put( delimited, dereferenced );
+    }
+  }
   /**
    * Writes the modified YAML document to standard output.
    */
   private void writeDocument() throws IOException {
     getObjectMapper().writeValue( System.out, getDocumentRoot() );
+  }
   /**
    * Called when a delimited reference is dereferenced to an empty string. This
    * should produce a warning for the user.
+   *
    * @param delimited Delimited reference with no derived value.
    */
   private void missing( final String delimited ) {
     throw new InvalidParameterException(
       MessageFormat.format( "Missing value for '{0}'.", delimited ) );
+  }
   /**
    * Returns a REGEX_PATTERN matcher for the given text.
+   *
    * @param text The text that contains zero or more instances of a
    * REGEX_PATTERN that can be found using the regular expression.
    */
   private Matcher patternMatch( String text ) {
     return getPattern().matcher( text );
+  }
   /**
    * Finds the YAML value for a reference.
+   *
    * @param reference References a value in the YAML document.
+   *
    * @return The dereferenced value.
    */
   private String lookup( final String reference ) {
     return getDocumentRoot().at( asPath( reference ) ).asText();
+  }
   /**
    * Converts a reference (not delimited) to a path that can be used to find a
    * value that should exist inside the YAML document.
+   *
    * @param reference The reference to convert to a YAML document path.
+   *
    * @return The reference with a leading slash and its separator characters
    * converted to slashes.
    */
   private String asPath( final String reference ) {
     return SEPARATOR_YAML + reference.replace( getDelimitedSeparator(), SEPARATOR_YAML );
+  }
   /**
    * Sets the parent node for the entire YAML document tree.
+   *
    * @param documentRoot The parent node.
    */
   private void setDocumentRoot( ObjectNode documentRoot ) {
     this.documentRoot = documentRoot;
+  }
   /**
    * Returns the parent node for the entire YAML document tree.
+   *
    * @return The parent node.
    */
   protected JsonNode getDocumentRoot() {
     return this.documentRoot;
+  }
   /**
    * Returns the compiled regular expression REGEX_PATTERN used to match
    * delimited references.
+   *
    * @return A compiled regex for use with the Matcher.
    */
   private Pattern getPattern() {
     return REGEX_PATTERN;
+  }
   /**
    * Returns the list of references mapped to dereferenced values.
+   *
    * @return
    */
   private Map<String, String> getReferences() {
     if( this.references == null ) {
       this.references = createReferences();
+    }
     return this.references;
+  }
   /**
    * Subclasses can override this method to insert their own map.
+   *
    * @return An empty HashMap, never null.
    */
   protected Map<String, String> createReferences() {
     return new HashMap<>();
+  }
   private final class ResolverYAMLFactory extends YAMLFactory {
     private static final long serialVersionUID = 1L;
     @Override
     protected YAMLGenerator _createGenerator(
       final Writer out, final IOContext ctxt ) throws IOException {
       return new ResolverYAMLGenerator(
         ctxt, _generatorFeatures, _yamlGeneratorFeatures, _objectCodec,
         out, _version );
+    }
+  }
   private class ResolverYAMLGenerator extends YAMLGenerator {
     public ResolverYAMLGenerator(
       final IOContext ctxt,
       final int jsonFeatures,
       final int yamlFeatures,
       final ObjectCodec codec,
       final Writer out,
       final DumperOptions.Version version ) throws IOException {
       super( ctxt, jsonFeatures, yamlFeatures, codec, out, version );
+    }
     @Override
     public void writeString( final String text )
       throws IOException, JsonGenerationException {
       super.writeString( substitute( text ) );
+    }
+  }
   private YAMLFactory getYAMLFactory() {
     return new ResolverYAMLFactory();
+  }
   private ObjectMapper getObjectMapper() {
     return new ObjectMapper( getYAMLFactory() );

M src/main/java/com/scrivenvar/definition/yaml/YamlTreeAdapter.java

 import com.fasterxml.jackson.databind.JsonNode;
 import com.scrivenvar.definition.VariableTreeItem;
 import java.io.IOException;
 import java.io.InputStream;
 import java.util.Map.Entry;
 import javafx.scene.control.TreeItem;
   /**
    * Converts a YAML document to a TreeView based on the document keys. Only the
    * first document in the stream is adapted. This does not close the stream.
    * first document in the stream is adapted.
+   *
    * @param in Contains a YAML document.
    * @param name Root TreeItem node name.
+   *
    * @return A TreeView populated with all the keys in the YAML document.
+   *
    * @throws IOException Could not read from the stream.
    */
   public TreeView<String> adapt( final InputStream in, final String name )
     throws IOException {
     final JsonNode rootNode = getYamlParser().process( in );
   public TreeView<String> adapt( final String name ){
     final JsonNode rootNode = getYamlParser().getDocumentRoot();
     final TreeItem<String> rootItem = createTreeItem( name );

D src/main/java/com/scrivenvar/test/TestDefinitionPane.java

 /*
  * Copyright 2016 White Magic Software, Ltd.
+ *
  * All rights reserved.
+ *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
+ *
  *  o Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
+ *
  *  o Redistributions in binary form must reproduce the above copyright
  *    notice, this list of conditions and the following disclaimer in the
  *    documentation and/or other materials provided with the distribution.
+ *
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 package com.scrivenvar.test;
 import com.scrivenvar.definition.DefinitionPane;
 import static javafx.application.Application.launch;
 import javafx.scene.control.TreeItem;
 import javafx.scene.control.TreeView;
 import javafx.stage.Stage;
 /**
  * TestDefinitionPane application for debugging.
  */
 public final class TestDefinitionPane extends TestHarness {
   /**
    * Application entry point.
+   *
    * @param stage The primary application stage.
+   *
    * @throws Exception Could not read configuration file.
    */
   @Override
   public void start( final Stage stage ) throws Exception {
     super.start( stage );
     TreeView<String> root = createTreeView();
     DefinitionPane pane = createDefinitionPane( root );
     test( pane, "language.ai.", "article" );
     test( pane, "language.ai", "ai" );
     test( pane, "l", "location" );
     test( pane, "la", "language" );
     test( pane, "c.p.n", "name" );
     test( pane, "c.p.n.", "First" );
     test( pane, "...", "c" );
     test( pane, "foo", "c" );
     test( pane, "foo.bar", "c" );
     test( pane, "", "c" );
     test( pane, "c", "protagonist" );
     test( pane, "c.", "protagonist" );
     test( pane, "c.p", "protagonist" );
     test( pane, "c.protagonist", "protagonist" );
     throw new RuntimeException( "Complete" );
+  }
   private void test( DefinitionPane pane, String path, String value ) {
     System.out.println( "---------------------------" );
     System.out.println( "Find Path: '" + path + "'" );
     final TreeItem<String> node = pane.findNode( path );
     System.out.println( "Path Node: " + node );
     System.out.println( "Node Val : " + node.getValue() );
+  }
   public static void main( String[] args ) {
     launch( args );
+  }
+}

D src/main/java/com/scrivenvar/test/TestHarness.java

 /*
  * Copyright 2016 White Magic Software, Ltd.
+ *
  * All rights reserved.
+ *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
+ *
  *  o Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
+ *
  *  o Redistributions in binary form must reproduce the above copyright
  *    notice, this list of conditions and the following disclaimer in the
  *    documentation and/or other materials provided with the distribution.
+ *
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 package com.scrivenvar.test;
 import static com.scrivenvar.Messages.get;
 import com.scrivenvar.definition.DefinitionPane;
 import com.scrivenvar.definition.yaml.YamlParser;
 import com.scrivenvar.definition.yaml.YamlTreeAdapter;
 import java.io.IOException;
 import java.io.InputStream;
 import javafx.application.Application;
 import javafx.scene.Scene;
 import javafx.scene.control.TreeView;
 import javafx.scene.layout.BorderPane;
 import javafx.stage.Stage;
 import org.fxmisc.flowless.VirtualizedScrollPane;
 import org.fxmisc.richtext.StyleClassedTextArea;
 /**
  * TestDefinitionPane application for debugging and head-banging.
  */
 public abstract class TestHarness extends Application {
   private static Application app;
   private Scene scene;
   /**
    * Application entry point.
+   *
    * @param stage The primary application stage.
+   *
    * @throws Exception Could not read configuration file.
    */
   @Override
   public void start( final Stage stage ) throws Exception {
     initApplication();
     initScene();
     initStage( stage );
+  }
   protected TreeView<String> createTreeView() throws IOException {
     return new YamlTreeAdapter( new YamlParser() ).adapt(
       asStream( "/com/scrivenvar/variables.yaml" ),
       get( "Pane.defintion.node.root.title" )
     );
+  }
   protected DefinitionPane createDefinitionPane( TreeView<String> root ) {
     return new DefinitionPane( root );
+  }
   private void initApplication() {
     app = this;
+  }
   private void initScene() {
     final StyleClassedTextArea editor = new StyleClassedTextArea( false );
     final VirtualizedScrollPane<StyleClassedTextArea> scrollPane = new VirtualizedScrollPane<>( editor );
     final BorderPane borderPane = new BorderPane();
     borderPane.setPrefSize( 1024, 800 );
     borderPane.setCenter( scrollPane );
     setScene( new Scene( borderPane ) );
+  }
   private void initStage( Stage stage ) {
     stage.setScene( getScene() );
+  }
   private Scene getScene() {
     return this.scene;
+  }
   private void setScene( Scene scene ) {
     this.scene = scene;
+  }
   private static Application getApplication() {
     return app;
+  }
   public static void showDocument( String uri ) {
     getApplication().getHostServices().showDocument( uri );
+  }
   protected InputStream asStream( String resource ) {
     return TestHarness.class.getResourceAsStream( resource );
+  }
+}

D src/main/java/com/scrivenvar/test/TestVariableNameProcessor.java

 /*
  * Copyright 2016 White Magic Software, Ltd.
+ *
  * All rights reserved.
+ *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
+ *
  *  o Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
+ *
  *  o Redistributions in binary form must reproduce the above copyright
  *    notice, this list of conditions and the following disclaimer in the
  *    documentation and/or other materials provided with the distribution.
+ *
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 package com.scrivenvar.test;
 import com.scrivenvar.definition.VariableTreeItem;
 import java.util.Collection;
 import java.util.HashMap;
 import java.util.Map;
 import static java.util.concurrent.ThreadLocalRandom.current;
 import java.util.concurrent.TimeUnit;
 import static java.util.concurrent.TimeUnit.DAYS;
 import static java.util.concurrent.TimeUnit.HOURS;
 import static java.util.concurrent.TimeUnit.MILLISECONDS;
 import static java.util.concurrent.TimeUnit.MINUTES;
 import static java.util.concurrent.TimeUnit.NANOSECONDS;
 import static java.util.concurrent.TimeUnit.SECONDS;
 import static javafx.application.Application.launch;
 import javafx.scene.control.TreeItem;
 import javafx.scene.control.TreeView;
 import javafx.stage.Stage;
 import org.ahocorasick.trie.*;
 import org.ahocorasick.trie.Trie.TrieBuilder;
 import static org.apache.commons.lang3.RandomStringUtils.randomNumeric;
 import org.apache.commons.lang3.StringUtils;
 /**
  * Tests substituting variable definitions with their values in a swath of text.
+ *
  * @author White Magic Software, Ltd.
  */
 public class TestVariableNameProcessor extends TestHarness {
   private final static int TEXT_SIZE = 1000000;
   private final static int MATCHES_DIVISOR = 1000;
   private final static StringBuilder SOURCE
     = new StringBuilder( randomNumeric( TEXT_SIZE ) );
   private final static boolean DEBUG = false;
   public TestVariableNameProcessor() {
+  }
   @Override
   public void start( final Stage stage ) throws Exception {
     super.start( stage );
     final TreeView<String> treeView = createTreeView();
     final Map<String, String> definitions = new HashMap<>();
     populate( treeView.getRoot(), definitions );
     injectVariables( definitions );
     final String text = SOURCE.toString();
     show( text );
     long duration = System.nanoTime();
     String result = testBorAhoCorasick( text, definitions );
     duration = System.nanoTime() - duration;
     show( result );
     System.out.println( elapsed( duration ) );
     duration = System.nanoTime();
     result = testStringUtils( text, definitions );
     duration = System.nanoTime() - duration;
     show( result );
     System.out.println( elapsed( duration ) );
     throw new RuntimeException( "Complete" );
+  }
   private void show( final String s ) {
     if( DEBUG ) {
       System.out.printf( "%s%n%n", s );
+    }
+  }
   private String testBorAhoCorasick(
     final String text,
     final Map<String, String> definitions ) {
     // Create a buffer sufficiently large that re-allocations are minimized.
     final StringBuilder sb = new StringBuilder( text.length() << 1 );
     final TrieBuilder builder = Trie.builder();
     builder.onlyWholeWords();
     builder.removeOverlaps();
     final String[] keys = keys( definitions );
     for( final String key : keys ) {
       builder.addKeyword( key );
+    }
     final Trie trie = builder.build();
     final Collection<Emit> emits = trie.parseText( text );
     int prevIndex = 0;
     for( final Emit emit : emits ) {
       final int matchIndex = emit.getStart();
       sb.append( text.substring( prevIndex, matchIndex ) );
       sb.append( definitions.get( emit.getKeyword() ) );
       prevIndex = emit.getEnd() + 1;
+    }
     // Add the remainder of the string (contains no more matches).
     sb.append( text.substring( prevIndex ) );
     return sb.toString();
+  }
   private String testStringUtils(
     final String text, final Map<String, String> definitions ) {
     final String[] keys = keys( definitions );
     final String[] values = values( definitions );
     return StringUtils.replaceEach( text, keys, values );
+  }
   private String[] keys( final Map<String, String> definitions ) {
     final int size = definitions.size();
     return definitions.keySet().toArray( new String[ size ] );
+  }
   private String[] values( final Map<String, String> definitions ) {
     final int size = definitions.size();
     return definitions.values().toArray( new String[ size ] );
+  }
   /**
    * Decomposes a period of time into days, hours, minutes, seconds,
    * milliseconds, and nanoseconds.
+   *
    * @param duration Time in nanoseconds.
+   *
    * @return A non-null, comma-separated string (without newline).
    */
   public String elapsed( long duration ) {
     final TimeUnit scale = NANOSECONDS;
     long days = scale.toDays( duration );
     duration -= DAYS.toMillis( days );
     long hours = scale.toHours( duration );
     duration -= HOURS.toMillis( hours );
     long minutes = scale.toMinutes( duration );
     duration -= MINUTES.toMillis( minutes );
     long seconds = scale.toSeconds( duration );
     duration -= SECONDS.toMillis( seconds );
     long millis = scale.toMillis( duration );
     duration -= MILLISECONDS.toMillis( seconds );
     long nanos = scale.toNanos( duration );
     return String.format(
       "%d days, %d hours, %d minutes, %d seconds, %d millis, %d nanos",
       days, hours, minutes, seconds, millis, nanos
     );
+  }
   private void injectVariables( final Map<String, String> definitions ) {
     for( int i = (SOURCE.length() / MATCHES_DIVISOR) + 1; i > 0; i-- ) {
       final int r = current().nextInt( 1, SOURCE.length() );
       SOURCE.insert( r, randomKey( definitions ) );
+    }
+  }
   private String randomKey( final Map<String, String> map ) {
     final Object[] keys = map.keySet().toArray();
     final int r = current().nextInt( keys.length );
     return keys[ r ].toString();
+  }
   private void populate( final TreeItem<String> parent, final Map<String, String> map ) {
     for( final TreeItem<String> child : parent.getChildren() ) {
       if( child.isLeaf() ) {
         final VariableTreeItem<String> item;
         if( child instanceof VariableTreeItem ) {
           item = ((VariableTreeItem<String>)child);
         } else {
           throw new IllegalArgumentException(
             "Child must be subclass of VariableTreeItem: " + child );
+        }
         final String key = asDefinition( item.toPath() );
         final String value = child.getValue();
         map.put( key, value );
       } else {
         populate( child, map );
+      }
+    }
+  }
   private String asDefinition( final String key ) {
     return "$" + key + "$";
+  }
   public static void main( String[] args ) {
     launch( args );
+  }
+}

28	28	package com.scrivenvar.definition;
29	29
30		import java.io.IOException;
31	30	import java.util.HashMap;
32	31	import java.util.Map;
...
44	43
45	44	@Override
46		public TreeView<String> asTreeView() throws IOException {
	45	public TreeView<String> asTreeView() {
47	46	return new TreeView<>();
48	47	}
49	48
50	49	@Override
51	50	public Map<String, String> getResolvedMap() {
52	51	return new HashMap<>();
53	52	}
54
55	53	}
56	54