/protocols/smpp/src/main/java/org/mobicents/protocols/smpp/message/DestinationTable.java

/*
 * JBoss, Home of Professional Open Source
 * Copyright 2011, Red Hat, Inc. and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.mobicents.protocols.smpp.message;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;

import org.slf4j.LoggerFactory;

import org.mobicents.protocols.smpp.Address;
import org.mobicents.protocols.smpp.util.PacketDecoder;
import org.mobicents.protocols.smpp.util.PacketEncoder;

/**
 * A table of destinations, primarily used in
 * {@link org.mobicents.protocols.smpp.message.SubmitMulti}.
 * @version $Id: DestinationTable.java 457 2009-01-15 17:37:42Z orank $
 */
public class DestinationTable implements Serializable {
    private static final long serialVersionUID = 2L;
    
    private List<Address> addresses = new ArrayList<Address>();
    private List<String> distributionLists = new ArrayList<String>();

    /**
     * The length is the total number of bytes the table would encode as.
     */
    private int length;

    public DestinationTable() {
    }

    public void add(Address addr) {
        addresses.add(addr);
        // Plus 1 for the dest type flag.
        length += addr.getLength() + 1;
    }

    public void add(String distributionList) {
        distributionLists.add(distributionList);
        // nul byte plus dest type flag
        length += distributionList.length() + 2;
    }

    public void remove(Address addr) {
        int i = addresses.indexOf(addr);
        if (i > -1) {
            length -= addresses.remove(i).getLength() + 1;
        }
    }

    public void remove(String distributionList) {
        int i = distributionLists.indexOf(distributionList);
        if (i > -1) {
            length -= distributionLists.remove(i).length() + 2;
        }
    }

    public int getLength() {
        return length;
    }

    public int size() {
        return addresses.size() + distributionLists.size();
    }

    public Collection<Address> getAddresses() {
        return Collections.unmodifiableCollection(addresses);
    }
    
    public Collection<String> getDistributionLists() {
        return Collections.unmodifiableCollection(distributionLists);
    }
    
    public void writeTo(PacketEncoder encoder) throws java.io.IOException {
        for (Address address : addresses) {
            encoder.writeUInt1(1);
            encoder.writeAddress(address);
        }
        for (String list : distributionLists) {
            encoder.writeUInt1(2);
            encoder.writeCString(list);
        }
    }

    public void readFrom(PacketDecoder decoder, int count) {
        for (int i = 0; i < count; i++) {
            int type = decoder.readUInt1();
            if (type == 1) {
                // SME address..
                addresses.add(decoder.readAddress());
            } else if (type == 2) {
                // Distribution list name
                distributionLists.add(decoder.readCString());
            } else {
                LoggerFactory.getLogger(DestinationTable.class).warn(
                        "Unidentified destination type on input.");
            }
        }
        calculateLength();
    }

    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null || !(obj instanceof DestinationTable)) {
            return false;
        }
        DestinationTable other = (DestinationTable) obj;
        return length == other.length
                && addresses.equals(other.addresses)
                && distributionLists.equals(other.distributionLists); 
    }
    
    public int hashCode() {
        return addresses.hashCode() + distributionLists.hashCode();
    }
    
    public String toString() {
        List<Object> list = new ArrayList<Object>();
        list.addAll(addresses);
        list.addAll(distributionLists);
        return list.toString();
    }
    
    private void calculateLength() {
        // One byte for all type flags, plus 1 (null) byte for each distribution
        // list string
        length = addresses.size() + (distributionLists.size() * 2);
        for (Address address : addresses) {
            // For the destination type flag
            length += address.getLength();
        }
        for (String list : distributionLists) {
            length += list.length();
        }
    }
}