net.sf.eBus.messages.EField Maven / Gradle / Ivy

Go to download
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later
// version.
//
// This library is distributed in the hope that it will be
// useful, but WITHOUT ANY WARRANTY; without even the implied
// warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
// PURPOSE. See the GNU Lesser General Public License for more
// details.
//
// You should have received a copy of the GNU Lesser General
// Public License along with this library; if not, write to the
//
// Free Software Foundation, Inc.,
// 59 Temple Place, Suite 330,
// Boston, MA
// 02111-1307 USA
//
// The Initial Developer of the Original Code is Charles W. Rapp.
// Portions created by Charles W. Rapp are
// Copyright (C) 2013, 2016. Charles W. Rapp.
// All Rights Reserved.
//

package net.sf.eBus.messages;

import java.io.Serializable;

/**
 * All application classes intended for use as an eBus messages
 * field must extend {@code EField}. This allows instances of
 * the application class to be serialized to a
 * {@link java.nio.ByteBuffer}. The application class must also
 * provide the {@link EFieldInfo} class-level annotation which
 * defines the serialized class field order.
 * 
 * Note: {@code EField} subclasses are limited
 * to 31 fields. This is due to eBus binary serialization format.
 * 
 * 
 * For more information about {@code EField} requirements, see
 * {@link EMessageObject}.
 * 
 *
 * @see EMessageObject
 * @see EMessage
 * @see EFieldInfo
 *
 * @author Charles Rapp
 */

@EFieldInfo(fields = {})
public abstract class EField
    extends EMessageObject
    implements Serializable
{
//---------------------------------------------------------------
// Member data.
//

    //-----------------------------------------------------------
    // Constants.
    //

    /**
     * Serialization version identifier.
     */
    private static final long serialVersionUID = 0x060100L;

//---------------------------------------------------------------
// Member methods.
//

    //-----------------------------------------------------------
    // Constructors.
    //

    /**
     * Creates a new eBus field instance. This construct is
     * public because the
     * {@link net.sf.eBus.messages.type.MessageType} requires
     * access.
     * @throws InvalidMessageException
     * if this field violates the eBus correct field rules.
     */
    public EField()
        throws InvalidMessageException
    {}

    //
    // end of Constructors.
    //-----------------------------------------------------------
} // end of class EField