com.github.besherman.lifx.LFXGroup Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of lifx-sdk-java Show documentation
A port of "LIFX Android SDK" to Java
The newest version!
/*
 * The MIT License
 *
 * Copyright 2014 Richard Löfberg.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.github.besherman.lifx;

import java.awt.Color;
import java.beans.PropertyChangeListener;

/**
 * A group of lights. This allows for multiple lights to be changed at a time.
 * If you are changing power or color on a lot of lights at the same
 * time the LIFX protocol only requires one message to be sent if you are
 * using a group.
 */
public interface LFXGroup extends LFXLightCollection {
    /**
     * Returns the group's label.
     */
    String getLabel();
    
    /**
     * Returns true if the label is allowed. It may not be null, empty or
     * longer than 32 bytes.
     */
    boolean isLabelAllowed(String newLabel);
    
    /**
     * Sets this group's label.
     * @throws IllegalArgumentException if isLabelAllowed(label) returns false.
     */
    void setLabel(String label);
    
    /**
     * Changes the power on all lights in this group.
     */
    void setPower(boolean power);

    /**
     * Sets the color of all lights in this group.
     */
    void setColor(LFXHSBKColor color);

    /**
     * Sets the color of all lights in this group.
     * @param color
     * @param duration the fade time in milliseconds
     */
    void setColor(LFXHSBKColor color, long duration);

    /**
     * Sets the color of all lights in this group.
     */
    void setColor(Color color);

    /**
     * Sets the color of all lights in this group.
     * @param color
     * @param duration the fade time in milliseconds
     */
    void setColor(Color color, long duration);
    
    /**
     * Adds a light to this group.
     */
    void add(LFXLight light);
    
    /**
     * Removes a light from this group.
     */
    void remove(LFXLight light);
        
    void addPropertyChangeListener(PropertyChangeListener l);
    void addPropertyChangeListener(String propertyName, PropertyChangeListener l);
    void removePropertyChangeListener(PropertyChangeListener l);    
}