UdhElement.java

/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (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.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is "SMS Library for the Java platform".
 *
 * The Initial Developer of the Original Code is Markus Eriksson.
 * Portions created by the Initial Developer are Copyright (C) 2002
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */
package vnet.sms.common.messages;

import static org.apache.commons.lang.Validate.notNull;

import java.io.IOException;
import java.io.OutputStream;
import java.io.Serializable;
import java.util.Arrays;

/**
 * Represents an User Data Header Element
 * 
 * @author Markus Eriksson
 * @version $Id: UdhElement.java 410 2006-03-13 19:48:31Z c95men $
 */
public class UdhElement implements Serializable {

	private static final long	serialVersionUID	= 4714737416450464409L;

	private final int	      udhIei_;

	private final byte[]	  udhIeiData_;

	/**
	 * Creates an UdhElement
	 * 
	 * @param udhIei
	 * @param udhIeiData
	 */
	public UdhElement(final int udhIei, final byte[] udhIeiData) {
		notNull(udhIeiData, "Argument 'udhIeiData' must not be null");
		this.udhIei_ = udhIei;
		this.udhIeiData_ = udhIeiData;
	}

	/**
	 * Returns the total length of this UDH element.
	 * <p>
	 * The length is including the UDH data length and the UDH "header" (2
	 * bytes)
	 * 
	 * @return the length
	 */
	public int getTotalSize() {
		return this.udhIeiData_.length + 2;
	}

	/**
	 * Returns the length of the UDH iei data
	 * <p>
	 * The length returned is only the length of the data
	 * 
	 * @return Length of data
	 */
	public int getUdhIeiDataLength() {
		return this.udhIeiData_.length;
	}

	/**
	 * Returns the Udh Iei Data excluding the UDH "header"
	 * 
	 * @return Data
	 */
	public byte[] getUdhIeiData() {
		return this.udhIeiData_;
	}

	/**
	 * Return the UDH element including the UDH "header" (two bytes)
	 * 
	 * @return Data
	 */
	public byte[] getData() {
		final byte[] allData = new byte[this.udhIeiData_.length + 2];

		allData[0] = (byte) (this.udhIei_ & 0xff);
		allData[1] = (byte) (this.udhIeiData_.length & 0xff);
		System.arraycopy(this.udhIeiData_, 0, allData, 2,
		        this.udhIeiData_.length);

		return allData;
	}

	/**
	 * Writes the UDH element including UDH "header" to the given stream
	 * 
	 * @param os
	 *            Stream to write to
	 * @throws IOException
	 */
	public void writeTo(final OutputStream os) throws IOException {
		os.write(this.udhIei_);
		os.write(this.udhIeiData_.length);
		os.write(this.udhIeiData_);
	}

	@Override
	public int hashCode() {
		final int prime = 31;
		int result = 1;
		result = prime * result + Arrays.hashCode(this.udhIeiData_);
		result = prime * result + this.udhIei_;
		return result;
	}

	@Override
	public boolean equals(final Object obj) {
		if (this == obj) {
			return true;
		}
		if (obj == null) {
			return false;
		}
		if (getClass() != obj.getClass()) {
			return false;
		}
		final UdhElement other = (UdhElement) obj;
		if (!Arrays.equals(this.udhIeiData_, other.udhIeiData_)) {
			return false;
		}
		if (this.udhIei_ != other.udhIei_) {
			return false;
		}
		return true;
	}

	@Override
	public String toString() {
		return "UdhElement@" + this.hashCode() + " [udhIei: " + this.udhIei_
		        + "|udhIeiData: " + Arrays.toString(this.udhIeiData_) + "]";
	}
}