org.bboxdb.network.packages.NetworkPackage Maven / Gradle / Ivy

Go to download
/*******************************************************************************
 *
 *    Copyright (C) 2015-2018 the BBoxDB project
 *  
 *    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 org.bboxdb.network.packages;

import java.io.OutputStream;


public abstract class NetworkPackage {
	
	/**
	 * The sequence number of the package
	 */
	protected final short sequenceNumber;
	
	public NetworkPackage(final short sequenceNumber) {
		this.sequenceNumber = sequenceNumber;
	}

	/**
	 * Returns the type of the package as a byte
	 * @return
	 */
	public abstract byte getPackageType();

	/**
	 * Get the sequence number
	 * @return
	 */
	public short getSequenceNumber() {
		return sequenceNumber;
	}
	
	/**
	 * Write the package to the stream
	 * 
	 * @param outputStream 
	 * @throws PackageEncodeException 
	 * @return written bytes
	 */
	public abstract long writeToOutputStream(final OutputStream outputStream) throws PackageEncodeException;

}