/*
* Copyright 2020 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.definition;
import javafx.scene.control.TreeItem;
import java.io.IOException;
import java.nio.file.Path;
/**
* Responsible for converting an object hierarchy into a {@link TreeItem}
* hierarchy.
*/
public interface TreeAdapter {
/**
* Adapts the document produced by the given parser into a {@link TreeItem}
* object that can be presented to the user within a GUI.
*
* @param root The default root node name.
* @return The parsed document in a {@link TreeItem} that can be displayed
* in a panel.
*/
TreeItem<String> adapt( String root );
/**
* Exports the given root node to the given path.
*
* @param root The root node to export.
* @param path Where to persist the data.
* @throws IOException Could not write the data to the given path.
*/
void export( TreeItem<String> root, Path path ) throws IOException;
}