com.quavo.osrs.network.protocol.packet.encode.PacketEncoder.java Source code

Introduction

Here is the source code for com.quavo.osrs.network.protocol.packet.encode.PacketEncoder.java

Source

/**
 * MIT License
 *
 * Copyright (c) 2017 Quavo
 * Copyright (c) 2017 Jordan Abraham
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package com.quavo.osrs.network.protocol.packet.encode;

import com.quavo.osrs.game.model.entity.actor.player.Player;
import com.quavo.osrs.network.protocol.packet.GamePacketBuilder;
import com.quavo.osrs.network.protocol.packet.context.PacketContext;

import io.netty.buffer.Unpooled;

/**
 * @author _jordan <citellumrsps@gmail.com>
 */
public abstract class PacketEncoder<T extends PacketContext> {

    /**
     * The {@link PacketEncoderIdentifier}.
     */
    private final PacketEncoderIdentifier packet;

    /**
     * Represents the buffer for building the packet.
     */
    protected final GamePacketBuilder builder;

    /**
     * Constructs a new object.
     *
     * @param packet The packet.
     */
    public PacketEncoder(PacketEncoderIdentifier packet) {
        this.packet = packet;
        this.builder = new GamePacketBuilder(Unpooled.buffer());
    }

    /**
     * Constructs a new object.
     * 
     * @param packet The packet.
     * @param size The packet size.
     */
    public PacketEncoder(PacketEncoderIdentifier packet, int size) {
        this.packet = packet;
        this.builder = new GamePacketBuilder(Unpooled.buffer(size));
    }

    /**
     * Gets the packet.
     * 
     * @return the packet
     */
    public PacketEncoderIdentifier getPacket() {
        return packet;
    }

    /**
     * Writes a packet.
     *
     * @param player The player.
     * @param context The packet wrapper.
     */
    public abstract void encode(Player player, T context);

    /**
     * Gets the builder.
     * 
     * @return the builder
     */
    public GamePacketBuilder getBuilder() {
        return builder;
    }

}