com.gluonhq.charm.down.common.PositionService 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 javafx.beans.property.ReadOnlyObjectProperty;

/**
 * The PositionService provides details about a device's current location on
 * earth. It provides a readonly position property that will be updated at
 * regular intervals by the underlying platform implementation. A user of the
 * PositionService can listen to changes of the position by registering a
 * {@link javafx.beans.value.ChangeListener ChangeListener} to the
 * {@link #positionProperty() position property}.
 */
public interface PositionService {

    /**
     * A readonly property containing information about the device's current
     * location on earth. The property can contain a null object
     * when the position of the device could be determined.
     *
     * @return a readonly object property containing the device's current
     * location
     */
    ReadOnlyObjectProperty positionProperty();

    /**
     * The current position on earth of the device. Can return null
     * when the position of the device could not be determined, for instance
     * when the GPS has been turned off.
     *
     * @return the current position of the device
     */
    Position getPosition();
}