MultiMessagePayload.java

/*
 * Copyright (C) 2009 JavaRosa
 *
 * Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

/**
 * 
 */
package org.openrosa.client.jr.core.services.transport.payload;

import java.io.IOException;
import java.util.Enumeration;
import java.util.Vector;

import org.openrosa.client.java.io.DataInputStream;
import org.openrosa.client.java.io.DataOutputStream;
import org.openrosa.client.jr.core.util.externalizable.DeserializationException;
import org.openrosa.client.jr.core.util.externalizable.ExtUtil;
import org.openrosa.client.jr.core.util.externalizable.ExtWrapListPoly;
import org.openrosa.client.jr.core.util.externalizable.PrototypeFactory;

/**
 * @author Clayton Sims
 * @date Dec 18, 2008 
 *
 */
public class MultiMessagePayload implements IDataPayload {
	/** IDataPayload **/
	Vector payloads = new Vector();
	
	/**
	 * Note: Only useful for serialization.
	 */
	public MultiMessagePayload() {
		//ONLY FOR SERIALIZATION
	}
	
	/**
	 * Adds a payload that should be sent as part of this
	 * payload.
	 * @param payload A payload that will be transmitted
	 * after all previously added payloads.
	 */
	public void addPayload(IDataPayload payload) {
		payloads.addElement(payload);
	}
	
	/**
	 *  @return A vector object containing each IDataPayload in this payload.
	 */
	public Vector getPayloads() {
		return payloads;
	}
	

	/*
	 * (non-Javadoc)
	 * @see org.javarosa.core.util.externalizable.Externalizable#readExternal(java.io.DataInputStream, org.javarosa.core.util.externalizable.PrototypeFactory)
	 */
	public void readExternal(DataInputStream in, PrototypeFactory pf)
			throws IOException, DeserializationException {
		//payloads = (Vector)ExtUtil.read(in, new ExtWrapList(new ExtWrapTagged()), pf);
		payloads = (Vector)ExtUtil.read(in, new ExtWrapListPoly(), pf);
	}

	/*
	 * (non-Javadoc)
	 * @see org.javarosa.core.util.externalizable.Externalizable#writeExternal(java.io.DataOutputStream)
	 */
	public void writeExternal(DataOutputStream out) throws IOException {
		//ExtUtil.write(out, new ExtWrapList(payloads));
		ExtUtil.write(out, new ExtWrapListPoly(payloads));
	}
	
	public Object accept(IDataPayloadVisitor visitor) {
		return visitor.visit(this);
	}

	public String getPayloadId() {
		return null;
	}

	public int getPayloadType() {
		return IDataPayload.PAYLOAD_TYPE_MULTI;
	}
	
	public int getTransportId() {
		return -1;
	}

	public long getLength() {
		int len = 0;
		Enumeration en = payloads.elements();
		while(en.hasMoreElements()) {
			IDataPayload payload = (IDataPayload)en.nextElement();
			len += payload.getLength();
		}
		return len;
	}
}