IOMessage.java

/*
 * socket.io-java-client IOMessage.java
 *
 * Copyright (c) 2013 Kyje
 * socket.io-java-client is a implementation of the socket.io protocol in Java.
 * 
 * See LICENSE file for more information
 */
package io.socket;

/**
 * The Class IOMessage.
 * Message format is:
 * [message type] ':' [message id ('+')] ':' [message endpoint] (':' [message data]) 
 */
class IOMessage {

	/** Message type disconnect */
	public static final int TYPE_DISCONNECT = 0;

	/** Message type connect */
	public static final int TYPE_CONNECT = 1;

	/** Message type heartbeat */
	public static final int TYPE_HEARTBEAT = 2;

	/** Message type message */
	public static final int TYPE_MESSAGE = 3;

	/** Message type JSON message */
	public static final int TYPE_JSON_MESSAGE = 4;

	/** Message type event */
	public static final int TYPE_EVENT = 5;

	/** Message type acknowledge */
	public static final int TYPE_ACK = 6;

	/** Message type error */
	public static final int TYPE_ERROR = 7;

	/** Message type noop */
	public static final int TYPE_NOOP = 8;

	/** Index of the type field in a message */
	public static final int FIELD_TYPE = 0;

	/** Index of the id field in a message */
	public static final int FIELD_ID = 1;

	/** Index of the end point field in a message */
	public static final int FIELD_ENDPOINT = 2;

	/** Index of the data field in a message */
	public static final int FIELD_DATA = 3;

	/** Number of fields in a message. */
	public static final int NUM_FIELDS = 4;

	private final int type;
	private String id;
	private String endpoint;
	private String data;
	
	/**
	 * Instantiates a new IOMessage by given data.
	 * 
	 * @param type
	 *            the type
	 * @param id
	 *            the id
	 * @param namespace
	 *            the namespace
	 * @param data
	 *            the data
	 */
	public IOMessage(int type, String id, String endpoint, String data) {
		this.type = type;
		this.id = id;
		this.endpoint = endpoint;
		this.data = data;
	}

	/**
	 * Instantiates a new IOMessage by given data.
	 * 
	 * @param type
	 *            the type
	 * @param namespace
	 *            the name space
	 * @param data
	 *            the data
	 */
	public IOMessage(int type, String namespace, String data) {
		this(type, null, namespace, data);
	}

	/**
	 * Instantiates a new IOMessage from a String representation. If the String
	 * is not well formated, the result is undefined.
	 * 
	 * @param message
	 *            the message
	 */
	public IOMessage(String message) {
		String[] fields = message.split(":", NUM_FIELDS);
		type = Integer.parseInt(fields[FIELD_TYPE]);
		int length = fields.length - 1;
		if(length >= FIELD_ID)
			id = fields[FIELD_ID];
		if(length >= FIELD_ENDPOINT)
			endpoint = fields[FIELD_ENDPOINT];
		if(length >= FIELD_DATA)
			data = fields[FIELD_DATA];
	}

	/**
	 * Generates a String representation of this object.
	 */
	@Override
	public String toString() {
		StringBuilder builder = new StringBuilder();
		builder.append(type).append(':');
		if(id != null)
			builder.append(id);
		builder.append(':');
		if(endpoint != null)
			builder.append(endpoint);
		if(data != null && !data.isEmpty())
		{
			builder.append(':');
			builder.append(data);
		}		
		return builder.toString();
	}

	/**
	 * Returns the type of this IOMessage.
	 * 
	 * @return the type
	 */
	public int getType() {
		return type;
	}

	/**
	 * Returns the id of this IOMessage.
	 * 
	 * @return the id
	 */
	public String getId() {
		return id;
	}

	/**
	 * Sets the id of this IOMessage
	 * 
	 * @param id
	 */
	public void setId(String id) {
		this.id = id;
	}

	/**
	 * Returns the endpoint of this IOMessage.
	 * 
	 * @return the endpoint
	 */
	public String getEndpoint() {
		return endpoint;
	}

	/**
	 * Returns the data of this IOMessage.
	 * 
	 * @return the data
	 */
	public String getData() {
		return data;
	}

}