BinInputStream.hpp Source File

00001 /*
00002  * The Apache Software License, Version 1.1

00003  * 

00004  * Copyright (c) 1999-2000 The Apache Software Foundation.  All rights

00005  * reserved.

00006  * 

00007  * Redistribution and use in source and binary forms, with or without

00008  * modification, are permitted provided that the following conditions

00009  * are met:

00010  * 

00011  * 1. Redistributions of source code must retain the above copyright

00012  *    notice, this list of conditions and the following disclaimer. 

00013  * 

00014  * 2. Redistributions in binary form must reproduce the above copyright

00015  *    notice, this list of conditions and the following disclaimer in

00016  *    the documentation and/or other materials provided with the

00017  *    distribution.

00018  * 

00019  * 3. The end-user documentation included with the redistribution,

00020  *    if any, must include the following acknowledgment:  

00021  *       "This product includes software developed by the

00022  *        Apache Software Foundation (http://www.apache.org/)."

00023  *    Alternately, this acknowledgment may appear in the software itself,

00024  *    if and wherever such third-party acknowledgments normally appear.

00025  * 

00026  * 4. The names "Xerces" and "Apache Software Foundation" must

00027  *    not be used to endorse or promote products derived from this

00028  *    software without prior written permission. For written 

00029  *    permission, please contact apache\@apache.org.

00030  * 

00031  * 5. Products derived from this software may not be called "Apache",

00032  *    nor may "Apache" appear in their name, without prior written

00033  *    permission of the Apache Software Foundation.

00034  * 

00035  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED

00036  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES

00037  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

00038  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR

00039  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

00040  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

00041  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF

00042  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND

00043  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,

00044  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT

00045  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF

00046  * SUCH DAMAGE.

00047  * ====================================================================

00048  * 

00049  * This software consists of voluntary contributions made by many

00050  * individuals on behalf of the Apache Software Foundation, and was

00051  * originally based on software copyright (c) 1999, International

00052  * Business Machines, Inc., http://www.ibm.com .  For more information

00053  * on the Apache Software Foundation, please see

00054  * <http://www.apache.org/>.

00055  */
00056 
00057 /*
00058  * $Log: BinInputStream.hpp,v $

00059  * Revision 1.4  2000/03/02 19:54:38  roddey

00060  * This checkin includes many changes done while waiting for the

00061  * 1.1.0 code to be finished. I can't list them all here, but a list is

00062  * available elsewhere.

00063  *
00064  * Revision 1.3  2000/02/24 20:05:23  abagchi

00065  * Swat for removing Log from API docs

00066  *
00067  * Revision 1.2  2000/02/06 07:48:01  rahulj

00068  * Year 2K copyright swat.

00069  *
00070  * Revision 1.1.1.1  1999/11/09 01:04:03  twl

00071  * Initial checkin

00072  *
00073  * Revision 1.3  1999/11/08 20:45:04  rahul

00074  * Swat for adding in Product name and CVS comment log variable.

00075  *
00076  */
00077 
00078 #if !defined(BININPUTSTREAM_HPP)
00079 #define BININPUTSTREAM_HPP
00080 
00081 #include <util/XercesDefs.hpp>
00082 
00083 class  BinInputStream
00084 {
00085 public :
00086     // -----------------------------------------------------------------------
00087     //  Virtual destructor for derived classes
00088     // -----------------------------------------------------------------------
00089     virtual ~BinInputStream();
00090 
00091 
00092     // -----------------------------------------------------------------------
00093     //  The virtual input stream interface
00094     // -----------------------------------------------------------------------
00095     virtual unsigned int curPos() const = 0;
00096 
00097     virtual unsigned int readBytes
00098     (
00099                 XMLByte* const      toFill
00100         , const unsigned int        maxToRead
00101     ) = 0;
00102 
00103 
00104 protected :
00105     // -----------------------------------------------------------------------
00106     //  Hidden Constructors
00107     // -----------------------------------------------------------------------
00108     BinInputStream();
00109 
00110 
00111 private :
00112     // -----------------------------------------------------------------------
00113     //  Unimplemented Constructors
00114     // -----------------------------------------------------------------------
00115     BinInputStream(const BinInputStream&);
00116     void operator=(const BinInputStream&);
00117 };
00118 
00119 #endif