IDocumentStorage.java

package fxutil.doc;

import java.io.IOException;
import java.util.Collection;

/**
 * An interface with the methods necessary for supporting the standard File menu actions. The class
 * representing the document (domain data container) is implicit in the implementation of this
 * interface. The interface includes methods for getting and setting the location and creating,
 * opening and saving the (current) document.
 *
 * @author hal
 *
 * @param <L> The type of the location, typically java.io.File.
 */
public interface IDocumentStorage<L> {
  /**
   * Returns the current location (of the current document).
   *
   * @return the current location
   */
  public L getDocumentLocation();

  /**
   * Sets the current location (of the current document), can be used by a save-as action.
   *
   * @param documentLocation the new document location
   */
  public void setDocumentLocation(L documentLocation);

  /**
   * Adds an IDocumentStorageListener that will be notified when the current location changes.
   *
   * @param documentStorageListener the listener to add
   */

  public void addDocumentStorageListener(IDocumentStorageListener<L> documentStorageListener);

  /**
   * Removes an IDocumentStorageListener.
   *
   * @param documentStorageListener the listener to remove
   */
  public void removeDocumentStorageListener(IDocumentStorageListener<L> documentStorageListener);

  /**
   * Creates a new documents and sets it as the current one, can be used by a new action.
   */
  public void newDocument();

  /**
   * Loads a documents from the provided location and sets it as the current one, can be used by an
   * open action.
   */
  public void openDocument(L documentLocation) throws IOException;

  /**
   * Saves the current document (to the current location), can be used by a save action.
   */
  public void saveDocument() throws IOException;

  /**
   * Returns the set of IDocumentImporters, can be used by an import action.
   *
   * @return
   */
  public Collection<IDocumentImporter> getDocumentImporters();
}