com.gluonhq.charm.down.common.ble.Configuration 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.ble;

import java.util.LinkedList;
import java.util.List;

public class Configuration {
    /**
     * uuid: set the initial uuid of beacons that will be scanned
     */
    private final List uuids = new LinkedList<>();
    
    /**
     * Create a configuration that allows to listen to the specified UUID
     * @param uuid the uuid of the beacons we will be monitoring/scanning
     */
    public Configuration(String uuid) {
        this.uuids.add(uuid);
    }
    
    /**
     * Adds a uuid to the list of beacons we want to monitor/scan
     * @param uuid the UUID of the beacons we want to follow
     */
    public void addUuid(String uuid) {
        this.uuids.add(uuid);
    }
    
    /**
     * Remove this uuid from the list of uuid-beacons we want to monitor/scan
     * @param uuid the uuid we want to remove
     */
    public void removeUuid(String uuid) {
        this.uuids.remove(uuid);
    }
    
    /**
     * Returns a list of uuids this configuration allows to monitor/scan.
     * This method never returns null.
     * @return the list of uuids, or an empty list of we don't want to follow a
     * specific uuid. 
     */
    public List getUuids() {
        return this.uuids;
    }
    
}