tuwien.auto.calimero.KNXAddress Maven / Gradle / Ivy
Show all versions of calimero-core Show documentation
/*
Calimero 2 - A library for KNX network access
Copyright (c) 2006, 2018 B. Malinowsky
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 of the License, 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 this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Linking this library statically or dynamically with other modules is
making a combined work based on this library. Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.
As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under terms
of your choice, provided that you also meet, for each linked independent
module, the terms and conditions of the license of that module. An
independent module is a module which is not derived from or based on
this library. If you modify this library, you may extend this exception
to your version of the library, but you are not obligated to do so. If
you do not wish to do so, delete this exception statement from your
version.
*/
package tuwien.auto.calimero;
import java.util.StringTokenizer;
import tuwien.auto.calimero.xml.KNXMLException;
import tuwien.auto.calimero.xml.XmlReader;
import tuwien.auto.calimero.xml.XmlWriter;
/**
* Represents a KNX address, consisting of a 16 Bit unsigned value. Concrete implementations of address are
* {@link GroupAddress} and {@link IndividualAddress}. Instances of KNXAddress are immutable.
* Loading and saving KNX addresses in XML format is supported.
*/
public abstract class KNXAddress implements Comparable
{
private static final String ATTR_TYPE = "type";
private static final String TAG_ADDRESS = "knxAddress";
int address;
/**
* Creates a KNX address from a 16 Bit address value.
*
* @param address the address value in the range [0..0xffff]
*/
KNXAddress(final int address)
{
init(address);
}
/**
* Creates a KNX address from a byte array.
*
* The address is read out of the first 2 byte fields, while the address array itself might be longer. The content
* of address is not modified.
*
* @param address the address byte array in big-endian format, with address.length ≥ 2
*/
KNXAddress(final byte[] address)
{
if (address.length < 2)
throw new KNXIllegalArgumentException("address byte array too short");
this.address = (address[0] & 0xFF) << 8 | (address[1] & 0xFF);
}
/**
* Creates a KNX address from its XML representation.
*
* If the current XML element position is no start tag, the next element tag is read. The KNX address element is
* then expected to be the current element in the reader.
*
* @param r a XML reader
* @throws KNXMLException if the XML element represents no KNX address or the address couldn't be read correctly
*/
KNXAddress(final XmlReader r) throws KNXMLException
{
if (r.getEventType() != XmlReader.START_ELEMENT)
r.nextTag();
if (r.getEventType() != XmlReader.START_ELEMENT || !r.getLocalName().equals(TAG_ADDRESS)
|| !getType().equals(r.getAttributeValue(null, ATTR_TYPE)))
throw new KNXMLException("XML element represents no KNX " + getType() + " address", r);
try {
init(r.getElementText());
}
catch (final KNXFormatException kfe) {
throw new KNXMLException("malformed KNX address value, " + kfe.getMessage(), r);
}
}
/**
* Creates KNX address 0 (reserved address).
*/
KNXAddress()
{}
/**
* Creates a KNX address from xml input, the KNX address element is expected to be the current or next element from
* the parser.
*
* @param r a XML reader
* @return the created KNXAddress, either of subtype {@link GroupAddress} or {@link IndividualAddress}
* @throws KNXMLException if the XML element is no KNX address, on unknown address type or wrong address syntax
*/
public static KNXAddress create(final XmlReader r) throws KNXMLException
{
if (r.getEventType() != XmlReader.START_ELEMENT)
r.nextTag();
if (r.getEventType() == XmlReader.START_ELEMENT) {
final String type = r.getAttributeValue(null, ATTR_TYPE);
if (GroupAddress.ATTR_GROUP.equals(type))
return new GroupAddress(r);
else if (IndividualAddress.ATTR_IND.equals(type))
return new IndividualAddress(r);
}
throw new KNXMLException("not a KNX address", r);
}
/**
* Creates a KNX address from a string address representation.
*
* An address level separator of type '.' found in address indicates an individual address, i.e., an
* {@link IndividualAddress} is created, otherwise a {@link GroupAddress} is created.
* Allowed separators are '.' or '/', mutually exclusive.
*
* @param address string containing the KNX address
* @return the created KNX address, either of subtype {@link GroupAddress} or {@link IndividualAddress}
* @throws KNXFormatException thrown on unknown address type, wrong address syntax or wrong separator used
*/
public static KNXAddress create(final String address) throws KNXFormatException
{
if (address.indexOf('.') != -1)
return new IndividualAddress(address);
if (address.indexOf('/') != -1)
return new GroupAddress(address);
throw new KNXFormatException("could not detect address type of " + address);
}
/**
* Returns the KNX address type, identifying a group or individual address.
*
*
* @return address type as string
*/
public abstract String getType();
/**
* Returns the KNX address in 16 Bit value representation.
*
*
* @return the 16 Bit address value
*/
public final int getRawAddress()
{
return address;
}
/**
* Writes the KNX address in XML format to the supplied writer.
*
* @param w a XML writer
* @throws KNXMLException on output error
*/
public void save(final XmlWriter w) throws KNXMLException
{
w.writeStartElement(TAG_ADDRESS);
w.writeAttribute(ATTR_TYPE, getType());
w.writeCharacters(toString());
w.writeEndElement();
}
/**
* Returns the raw address value in a new byte array.
*
* @return The address value. The high byte of the address is placed at index 0.
*/
public final byte[] toByteArray()
{
return new byte[] { (byte) (address >>> 8), (byte) address };
}
@Override
public int compareTo(final KNXAddress other)
{
return address - other.address;
}
static String[] parse(final String address) throws KNXFormatException
{
StringTokenizer t = null;
if (address.indexOf('/') > -1)
t = new StringTokenizer(address, "/");
else if (address.indexOf('.') > -1)
t = new StringTokenizer(address, ".");
else
return new String[] { address };
final int count = t.countTokens();
if (count == 2)
return new String[] { t.nextToken(), t.nextToken() };
else if (count == 3)
return new String[] { t.nextToken(), t.nextToken(), t.nextToken(), };
else
throw new KNXFormatException("wrong KNX address syntax with " + count + " levels", address);
}
abstract void init(String address) throws KNXFormatException;
void init(final int address)
{
if (address < 0 || address > 0xffff)
throw new KNXIllegalArgumentException("address out of range [0..0xFFFF]");
this.address = address;
}
}