org.sputnikdev.bluetooth.manager.GattCharacteristic Maven / Gradle / Ivy

Go to download
package org.sputnikdev.bluetooth.manager;

/*-
 * #%L
 * org.sputnikdev:bluetooth-manager
 * %%
 * Copyright (C) 2017 Sputnik Dev
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */

import org.sputnikdev.bluetooth.URL;
import org.sputnikdev.bluetooth.manager.transport.CharacteristicAccessType;

import java.util.Collections;
import java.util.Set;

/**
 * A class to capture discovered GATT characteristics.
 *
 * @author Vlad Kolotov
 */
public class GattCharacteristic {

    private final URL url;
    private final Set flags;

    /**
     * Creates a new object.
     * @param url characteristic URL
     * @param flags characteristic access flags
     */
    public GattCharacteristic(URL url, Set flags) {
        this.url = url;
        this.flags = flags;
    }

    /**
     * Returns characteristic URL.
     * @return characteristic URL
     */
    public URL getURL() {
        return url;
    }

    /**
     * Returns characteristic access flags.
     * @return characteristic access flags
     */
    public Set getFlags() {
        return Collections.unmodifiableSet(flags);
    }
}