ca.nrc.cadc.io.BulkDataOutput Maven / Gradle / Ivy
Show all versions of cadc-util Show documentation
/*
************************************************************************
******************* CANADIAN ASTRONOMY DATA CENTRE *******************
************** CENTRE CANADIEN DE DONNÉES ASTRONOMIQUES **************
*
* (c) 2016. (c) 2016.
* Government of Canada Gouvernement du Canada
* National Research Council Conseil national de recherches
* Ottawa, Canada, K1A 0R6 Ottawa, Canada, K1A 0R6
* All rights reserved Tous droits réservés
*
* NRC disclaims any warranties, Le CNRC dénie toute garantie
* expressed, implied, or énoncée, implicite ou légale,
* statutory, of any kind with de quelque nature que ce
* respect to the software, soit, concernant le logiciel,
* including without limitation y compris sans restriction
* any warranty of merchantability toute garantie de valeur
* or fitness for a particular marchande ou de pertinence
* purpose. NRC shall not be pour un usage particulier.
* liable in any event for any Le CNRC ne pourra en aucun cas
* damages, whether direct or être tenu responsable de tout
* indirect, special or general, dommage, direct ou indirect,
* consequential or incidental, particulier ou général,
* arising from the use of the accessoire ou fortuit, résultant
* software. Neither the name de l'utilisation du logiciel. Ni
* of the National Research le nom du Conseil National de
* Council of Canada nor the Recherches du Canada ni les noms
* names of its contributors may de ses participants ne peuvent
* be used to endorse or promote être utilisés pour approuver ou
* products derived from this promouvoir les produits dérivés
* software without specific prior de ce logiciel sans autorisation
* written permission. préalable et particulière
* par écrit.
*
* This file is part of the Ce fichier fait partie du projet
* OpenCADC project. OpenCADC.
*
* OpenCADC is free software: OpenCADC est un logiciel libre ;
* you can redistribute it and/or vous pouvez le redistribuer ou le
* modify it under the terms of modifier suivant les termes de
* the GNU Affero General Public la “GNU Affero General Public
* License as published by the License” telle que publiée
* Free Software Foundation, par la Free Software Foundation
* either version 3 of the : soit la version 3 de cette
* License, or (at your option) licence, soit (à votre gré)
* any later version. toute version ultérieure.
*
* OpenCADC is distributed in the OpenCADC est distribué
* hope that it will be useful, dans l’espoir qu’il vous
* but WITHOUT ANY WARRANTY; sera utile, mais SANS AUCUNE
* without even the implied GARANTIE : sans même la garantie
* warranty of MERCHANTABILITY implicite de COMMERCIALISABILITÉ
* or FITNESS FOR A PARTICULAR ni d’ADÉQUATION À UN OBJECTIF
* PURPOSE. See the GNU Affero PARTICULIER. Consultez la Licence
* General Public License for Générale Publique GNU Affero
* more details. pour plus de détails.
*
* You should have received Vous devriez avoir reçu une
* a copy of the GNU Affero copie de la Licence Générale
* General Public License along Publique GNU Affero avec
* with OpenCADC. If not, see OpenCADC ; si ce n’est
* . pas le cas, consultez :
* .
*
* $Revision: 5 $
*
************************************************************************
*/
package ca.nrc.cadc.io;
import java.io.IOException;
/**
* Interface for classes which write arrays of builtin data types.
*
* Each integer data type can be written from an array of the exact type.
* Unsigned integer types are written using an array of the next larger type
* since java does not have unsigned types per se.
*
* @version 0.1
* @author Patrick Dowler
*/
public interface BulkDataOutput {
public void flush() throws IOException;
// write 8-bit signed -> byte
public void writeByte(byte b) throws IOException;
public void writeByte(byte[] buf) throws IOException;
public void writeByte(byte[] buf, int off, int len) throws IOException;
// write 8-bit unsigned -> short
public void writeUnsignedByte(short[] buf) throws IOException;
public void writeUnsignedByte(short[] buf, int off, int len) throws IOException;
// write characters
public void writeChar(char[] buf) throws IOException;
public void writeChar(char[] buf, int off, int len) throws IOException;
// write 16-bit signed integers
public void writeShort(short[] buf) throws IOException;
public void writeShort(short[] buf, int off, int len) throws IOException;
// write 16-bit unsigned -> int
public void writeUnsignedShort(int[] buf) throws IOException;
public void writeUnsignedShort(int[] buf, int off, int len) throws IOException;
// write 32-bit signed integers
public void writeInt(int[] buf) throws IOException;
public void writeInt(int[] buf, int off, int len) throws IOException;
// write 64-bit signed integers
public void writeLong(long[] buf) throws IOException;
public void writeLong(long[] buf, int off, int len) throws IOException;
// write 32-bit floating point values
public void writeFloat(float[] buf) throws IOException;
public void writeFloat(float[] buf, int off, int len) throws IOException;
// write 64-bit floating point values
public void writeDouble(double[] buf) throws IOException;
public void writeDouble(double[] buf, int off, int len) throws IOException;
}