001/*
002 * Trident - A Multithreaded Server Alternative
003 * Copyright 2014 The TridentSDK Team
004 *
005 * Licensed under the Apache License, Version 2.0 (the "License");
006 * you may not use this file except in compliance with the License.
007 * You may obtain a copy of the License at
008 *
009 *    http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018package net.tridentsdk.server.data;
019
020import io.netty.buffer.ByteBuf;
021
022/**
023 * A metadata abstraction that allows the data to be written to provided {@link io.netty.buffer.ByteBuf}
024 *
025 * @author The TridentSDK Team
026 */
027public interface Writable {
028    /**
029     * Writes the data contained by the current implementation into serialized form in the provided {@link
030     * io.netty.buffer.ByteBuf}
031     *
032     * <p>Check the implementation source to see serialization spec</p>
033     *
034     * @param buf the buffer to toPacket the serialized form to
035     */
036    void write(ByteBuf buf);
037}