PrivateChannelLeavePacket.java

/*
 * PrivateChannelLeavePacket.java
 *
 * Created on September 13, 2010, 2:30 PM
 *************************************************************************
 * Copyright 2010 Kevin Kendall
 *
 * 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 ao.protocol.packets.toserver;

import ao.protocol.packets.*;
import ao.protocol.packets.utils.PacketParser;
import ao.protocol.packets.utils.PacketSerializer;

import java.io.IOException;

public class PrivateChannelLeavePacket extends Packet {

    public static final short TYPE = 53;
    private final byte[] m_data;
    private final int m_id;

    /**
     * Creates a new instance of PrivateChannelLeavePacket
     *
     * @param id
     *        The id of the character hosting the channel
     */
    public PrivateChannelLeavePacket(int id) {
        m_id = id;
        // Serialize the packet
        PacketSerializer serializer =
                new PacketSerializer(4 + 4);
        serializer.write(id);

        m_data = serializer.getResult();
        serializer.close();
    }   // end PrivateChannelLeavePacket()

    /**
     * Creates a new instance of PrivateChannelLeavePacket
     *
     * @param data
     *         the binary data of this packet (without the type and length bytes)
     * @throws NullPointerException
     *         if data is null
     * @throws AOMalformedPacketException
     *         if the packet is malformed
     */
    public PrivateChannelLeavePacket(byte[] data) throws MalformedPacketException {
        if (data == null) {
            throw new NullPointerException("No binary data was passed.");
        }

        try {
            m_data = data;
            PacketParser parser = new PacketParser(data);
            // Parse the packet
            m_id = parser.parseInt();

            parser.close();
        } catch (IOException e) {
            throw new MalformedPacketException(
                    "The packet could not be parsed.", e, new UnparsablePacket(TYPE, data, Direction.TO_SERVER));
        }   // end catch
    }   // end PrivateChannelLeavePacket()

    public int getGroupID() {
        return m_id;
    }

    /** Always returns {@value #TYPE} */
    public short getType() {
        return TYPE;
    }

    public byte[] getData() {
        return m_data;
    }

    /** Always returns {@code Direction.TO_CLIENT} */
    public Direction getDirection() {
        return Direction.TO_SERVER;
    }

    @Override
    public String toString() {
        String result = "[" + TYPE + "]PrivateChannelPartPacket: " + m_id;
        return result;
    }   // end toString()
}   // end class PrivateChannelLeavePacket