com.gluonhq.charm.down.common.Platform Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of charm-down-common Show documentation
API to access features for the mobile platforms
The newest version!
/*
 * Copyright (c) 2015, Gluon
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * 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.
 *     * Neither the name of Gluon, any associated website, nor the
 * names of its contributors may be used to endorse or promote products
 * derived from this software without specific prior written permission.
 *
 * 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 GLUON 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.gluonhq.charm.down.common;

import com.gluonhq.charm.down.common.cache.CacheManager;
import com.gluonhq.charm.down.common.cache.DefaultCacheManager;
import javafx.geometry.Orientation;
import javafx.util.Callback;

import java.io.File;
import java.io.IOException;
import java.net.URISyntaxException;
import java.util.Optional;

public abstract class Platform
{

    /**
     * Return the name of this Platform, i.e. one of
     * {Android, Desktop, iOS}
     *
     * @return the name of this Platform
     */
    public abstract String getName();

    /**
     * Get a storage directory that is private to the environment that is
     * calling this method. In the case of iOS or Android, the returned
     * directory is private to the enclosing application.
     *
     * @return a private storage directory for a mobile application
     * @throws java.io.IOException when a problem occurred when trying to get
     *                             the private storage on the underlying platform
     */
    public abstract File getPrivateStorage() throws IOException;

    /**
     * Retrieves the platform specific implementation of a
     * {@link PositionService}.
     *
     * @return a platform specific implementation of a PositionService
     */
    public abstract PositionService getPositionService();

    /**
     * Retrieves the platform specific implementation of a
     * {@link SettingService}.
     *
     * @return a platform specific implementation of a SettingService
     */
    public abstract SettingService getSettingService();

    public abstract BleService getBleService();

    /**
     * Retrieves the platform specific implementation of a
     * {@link NotificationsService}.

     * @return a platform specific implementation of a NotificationsService
     */
    public abstract NotificationsService getNotificationsService();

    public CacheManager getCacheManager() {
        return new DefaultCacheManager();
    }

    public void setOnLifecycleEvent(Callback callback) {

    }

    public static enum LifecycleEvent {

        START,
        PAUSE,
        RESUME,
        STOP
    }

    /*
     * Launches the user-default browser to show a specified URI
     */
    public abstract void launchExternalBrowser(String url) throws IOException, URISyntaxException;

    public abstract Optional getOrientation();

    /*
    Convenience method to terminate the application
    */
    public abstract void finish();
    
    /*
    Check if device is running on a tablet (true) or a mobile (false)
    */
    public abstract boolean isTablet();
    
    /*
    Get the scan service
    */
    public abstract ScanService getScanService();
    
    /*
    Get the pictures service
    */
    public abstract PicturesService getPicturesService();
    
}