xmlhelp/source/cxxhelp/inc/util/RandomAccessStream.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: RandomAccessStream.hxx,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef _XMLEARCH_UTIL_RANDOMACCESSSTREAM_HXX_
  31 #define _XMLEARCH_UTIL_RANDOMACCESSSTREAM_HXX_
  32
  33 #include <osl/file.hxx>
  34
  35 namespace xmlsearch {
  36
  37     namespace util {
  38
  39
  40         class RandomAccessStream
  41         {
  42         public:
  43
  44             virtual ~RandomAccessStream() { };
  45
  46             // The calle is responsible for allocating the buffer
  47             virtual void seek( sal_Int32 ) = 0;
  48             virtual sal_Int32 readBytes( sal_Int8*,sal_Int32 ) = 0;
  49             virtual void writeBytes( sal_Int8*, sal_Int32 ) = 0;
  50             virtual sal_Int32 length() = 0;
  51             virtual void close() = 0;
  52
  53
  54         protected:
  55
  56             enum OPENFLAG { Read = OpenFlag_Read,
  57                             Write = OpenFlag_Write,
  58                             Create = OpenFlag_Create };
  59
  60         };
  61
  62
  63     }
  64 }
  65
  66 #endif