com.freedomotic.reactions.Command Maven / Gradle / Ivy
/**
*
* Copyright (c) 2009-2014 Freedomotic team http://freedomotic.com
*
* This file is part of Freedomotic
*
* This Program is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License as published by the Free Software
* Foundation; either version 2, or (at your option) any later version.
*
* This Program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
* details.
*
* You should have received a copy of the GNU General Public License along with
* Freedomotic; see the file COPYING. If not, see
* tags = new HashSet();
//by default a command is userLevel, this means that can be used in reactions.
//Hardware level commands cannot be used in reactions but only linked to an object action
private boolean hardwareLevel;
private boolean editable;
private boolean executed;
@XmlElement
private Config properties = new Config();
/**
*
*/
public Command() {
this.uuid = UUID.randomUUID().toString();
if (isHardwareLevel()) { //an hardware level command
setEditable(false); //it has not to me stored in root/data folder
}
}
/**
*
* @return
*/
public HashSet getTags() {
if (tags == null) {
tags = new HashSet();
tags.addAll(Arrays.asList(getName().toLowerCase().split(" ")));
}
return tags;
}
/**
*
* @param tags
*/
public void setTags(HashSet tags) {
this.tags = tags;
}
/**
*
* @return
*/
public String getDescription() {
if (description == null) {
description = getName();
}
return description;
}
/**
*
* @param description
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* @return
*/
public String getUuid() {
if (uuid == null || uuid.trim().equals("")){
uuid= UUID.randomUUID().toString();
}
return uuid;
}
/**
*
* @param uuid
*/
public void setUUID(String uuid) {
this.uuid = uuid;
}
/**
*
* @return
*/
public boolean isHardwareLevel() {
return hardwareLevel;
}
/**
*
* @param hardwareLevel
*/
public void setHardwareLevel(boolean hardwareLevel) {
this.hardwareLevel = hardwareLevel;
}
/**
*
* @return
*/
public boolean isEditable() {
return editable;
}
/**
*
* @param persistence
*/
public void setEditable(boolean persistence) {
this.editable = persistence;
}
/**
*
* @return
*/
public String getStopIf() {
return stopIf;
}
/**
*
* @param continueIf
*/
public void setStopIf(String continueIf) {
this.stopIf = continueIf;
}
/**
*
* @return
*/
@XmlTransient
public String getBehavior() {
if (properties.getProperty("behavior") != null) {
return properties.getProperty("behavior");
} else {
LOG.warning("Undefined property 'behavior' in command '" + this.getName() + "'");
return "undefined-behavior";
}
}
/**
*
* @param key
* @return
*/
public String getProperty(String key) {
return properties.getProperty(key);
}
/**
*
* @param key
* @param value
*/
public void setProperty(String key, String value) {
if (!key.isEmpty()) {
properties.setProperty(key, value);
}
}
/**
*
* @return
*/
public Config getProperties() {
return properties;
}
/**
* Creates an oredred list reading the command properties writed in format
* "parameter[AN_INT_FROM_0_TO_999]" other properties format are ignored
* (not added to the returned List) The indexs must be contiguous
* (1,2,3,...) for example:
*
*
parameter[0] = foo parameter[1] = bar
* parameter[3] = asd object = Light 1 another-param =
* myValue
*
* The returned ArrayList is [0]->foo [1]->bar
* because the index = 2 is missing.
*
* @return an ordered ArrayList of command parameter values
*/
@XmlTransient
public ArrayList getParametersAsList() {
ArrayList output = new ArrayList();
//99 is the max num of elements in list
for (int i = 0; i < 99; i++) {
String value = null;
value = properties.getProperties().getProperty("parameter[" + i + "]");
if (value != null) {
//add to array
output.add(value);
} else {
//if the elements are not contiguous return
return output;
}
}
return output;
}
/**
*
* @return
*/
public int getDelay() {
if (delay > 0) {
return delay;
} else {
return 0;
}
}
/**
*
* @param delay
*/
public void setDelay(int delay) {
this.delay = delay;
}
/**
*
* @return
*/
public String getName() {
return name;
}
/**
*
* @param name
*/
public void setName(String name) {
this.name = name.trim();
}
/**
*
* @return
*/
public String getReceiver() {
return receiver;
}
/**
*
* @param receiver
*/
public void setReceiver(String receiver) {
this.receiver = receiver;
}
/**
*
* @param value
*/
public void setExecuted(boolean value) {
executed = value;
}
/**
*
* @return
*/
public boolean isExecuted() {
return executed;
}
/**
* Two commands are considered equals if they have the same name
* @param obj
* @return
*/
@Override
public boolean equals(Object obj) {
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
final Command other = (Command) obj;
if ((this.name == null) ? (other.name != null) : (!this.name.equals(other.name))) {
return false;
}
return true;
}
/**
*
* @return
*/
@Override
public int hashCode() {
int hash = 5;
hash = (53 * hash) + ((this.name != null) ? this.name.hashCode() : 0);
return hash;
}
/**
*
* @return
* @throws CloneNotSupportedException
*/
@Override
public Command clone()
throws CloneNotSupportedException {
super.clone();
Command clonedCmd = new Command();
clonedCmd.setName(getName());
clonedCmd.setDescription(getDescription());
clonedCmd.setReceiver(getReceiver());
clonedCmd.setDelay(getDelay());
clonedCmd.setReplyTimeout(getReplyTimeout());
clonedCmd.setExecuted(executed);
clonedCmd.setHardwareLevel(hardwareLevel);
Iterator> it = getProperties().entrySet().iterator();
while (it.hasNext()) {
Entry e = it.next();
clonedCmd.setProperty(e.getKey().toString(), e.getValue().toString()); //adding the original command properties to its clone
}
clonedCmd.properties.setXmlFile(this.getName());
return clonedCmd;
}
/**
*
*/
public void destroy() {
name = null;
receiver = null;
description = null;
stopIf = null;
properties.getProperties().clear();
properties = null;
}
/**
*
* @return
*/
@Override
public String toString() {
return getName();
}
/**
*
* @return
*/
public int getReplyTimeout() {
return timeout;
}
/**
*
* @param timeout
*/
public void setReplyTimeout(int timeout) {
this.timeout = timeout;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy