| API Docs for SAX and DOM |

Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members

# BinFileInputStream.hpp

Go to the documentation of this 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: BinFileInputStream.hpp,v $
    00059  * Revision 1.1.1.1  2002/02/01 22:22:09  peiyongz
    00060  * sane_include
    00061  *
    00062  * Revision 1.3  2000/02/24 20:05:23  abagchi
    00063  * Swat for removing Log from API docs
    00064  *
    00065  * Revision 1.2  2000/02/06 07:48:01  rahulj
    00066  * Year 2K copyright swat.
    00067  *
    00068  * Revision 1.1.1.1  1999/11/09 01:04:00  twl
    00069  * Initial checkin
    00070  *
    00071  * Revision 1.3  1999/11/08 20:45:03  rahul
    00072  * Swat for adding in Product name and CVS comment log variable.
    00073  *
    00074  */
    00075
    00076 #if !defined(BINFILEINPUTSTREAM_HPP)
    00077 #define BINFILEINPUTSTREAM_HPP
    00078
    00079 #include <xercesc/util/BinInputStream.hpp>
    00080
    00081
    00082 class  BinFileInputStream : public BinInputStream
    00083 {
    00084 public :
    00085     // -----------------------------------------------------------------------
    00086     //  Constructors and Destructor
    00087     // -----------------------------------------------------------------------
    00088     BinFileInputStream
    00089     (
    00090         const   XMLCh* const    fileName
    00091     );
    00092
    00093     BinFileInputStream
    00094     (
    00095         const   char* const     fileName
    00096     );
    00097
    00098     BinFileInputStream
    00099     (
    00100         const   FileHandle      toUse
    00101     );
    00102
    00103     virtual ~BinFileInputStream();
    00104
    00105
    00106     // -----------------------------------------------------------------------
    00107     //  Getter methods
    00108     // -----------------------------------------------------------------------
    00109     bool getIsOpen() const;
    00110     unsigned int getSize() const;
    00111     void reset();
    00112
    00113
    00114     // -----------------------------------------------------------------------
    00115     //  Implementation of the input stream interface
    00116     // -----------------------------------------------------------------------
    00117     virtual unsigned int curPos() const;
    00118
    00119     virtual unsigned int readBytes
    00120     (
    00121                 XMLByte* const      toFill
    00122         , const unsigned int        maxToRead
    00123     );
    00124
    00125
    00126 private :
    00127     // -----------------------------------------------------------------------
    00128     //  Private data members
    00129     //
    00130     //  fSource
    00131     //      The source file that we represent. The FileHandle type is defined
    00132     //      per platform.
    00133     // -----------------------------------------------------------------------
    00134     FileHandle      fSource;
    00135 };
    00136
    00137
    00138 // ---------------------------------------------------------------------------
    00139 //  BinFileInputStream: Getter methods
    00140 // ---------------------------------------------------------------------------
    00141 inline bool BinFileInputStream::getIsOpen() const
    00142 {
    00143     return (fSource != 0);
    00144 }
    00145
    00146 #endif

Copyright © 2000 The Apache Software Foundation. All Rights Reserved.