001/* 002 * Copyright 2006 - 2013 003 * Stefan Balev <stefan.balev@graphstream-project.org> 004 * Julien Baudry <julien.baudry@graphstream-project.org> 005 * Antoine Dutot <antoine.dutot@graphstream-project.org> 006 * Yoann Pigné <yoann.pigne@graphstream-project.org> 007 * Guilhelm Savin <guilhelm.savin@graphstream-project.org> 008 * 009 * This file is part of GraphStream <http://graphstream-project.org>. 010 * 011 * GraphStream is a library whose purpose is to handle static or dynamic 012 * graph, create them from scratch, file or any source and display them. 013 * 014 * This program is free software distributed under the terms of two licenses, the 015 * CeCILL-C license that fits European law, and the GNU Lesser General Public 016 * License. You can use, modify and/ or redistribute the software under the terms 017 * of the CeCILL-C license as circulated by CEA, CNRS and INRIA at the following 018 * URL <http://www.cecill.info> or under the terms of the GNU LGPL as published by 019 * the Free Software Foundation, either version 3 of the License, or (at your 020 * option) any later version. 021 * 022 * This program is distributed in the hope that it will be useful, but WITHOUT ANY 023 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A 024 * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. 025 * 026 * You should have received a copy of the GNU Lesser General Public License 027 * along with this program. If not, see <http://www.gnu.org/licenses/>. 028 * 029 * The fact that you are presently reading this means that you have had 030 * knowledge of the CeCILL-C and LGPL licenses and that you accept their terms. 031 */ 032package org.graphstream.stream.netstream.packing; 033 034import java.nio.ByteBuffer; 035 036/** 037 * 038 */ 039public abstract class NetStreamPacker { 040 041 /** 042 * Pack the given ByteBuffer from startIndex to endIdex 043 * @param buffer The buffer to pack/encode 044 * @param startIndex the index at which the encoding starts in the buffer 045 * @param endIndex the index at which the encoding stops 046 * @return a ByteBuffer that is the packed version of the input one. It may not have the same size. 047 */ 048 public abstract ByteBuffer packMessage(ByteBuffer buffer, int startIndex, int endIndex); 049 050 /** 051 * Pack the given ByteBuffer form its position to its capacity. 052 * @param buffer The buffer to pack/encode 053 * @return a ByteBuffer that is the packed version of the input one. It may not have the same size. 054 */ 055 public ByteBuffer packMessage(ByteBuffer buffer){ 056 return this.packMessage(buffer, 0, buffer.capacity()); 057 } 058 059 /** 060 * @param capacity 061 * @return 062 */ 063 public abstract ByteBuffer packMessageSize(int capacity) ; 064 065}