001/*
002 * Copyright 2019-2021 M. Sean Gilligan.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package app.supernaut.services;
017
018import java.net.URI;
019
020/**
021 * Interface that abstracts JavaFX {@code }HostServices.showDocument()}
022 * Use this interface to controllers/services that wish to tell a browser
023 * to open a window. The interface allows you to not reference JavaFX
024 * in your controller and to use mocks/stubs for unit test, etc.
025 */
026public interface BrowserService {
027    /**
028     * Opens the specified URI in a new browser window or tab.
029     *
030     * @param uri the URI of the web page that will be opened in a browser.
031     */
032    void showDocument(String uri);
033
034    /**
035     * Convenience method that takes URI
036     *
037     * @param uri the URI of the web page that will be opened in a browser
038     */
039    default void showDocument(URI uri) {
040        showDocument(uri.toString());
041    }
042}