src/client-api/src/include/common/syncml/core/SourceArray.h

   1 /*
   2  * Funambol is a mobile platform developed by Funambol, Inc.
   3  * Copyright (C) 2003 - 2007 Funambol, Inc.
   4  *
   5  * This program is free software; you can redistribute it and/or modify it under
   6  * the terms of the GNU Affero General Public License version 3 as published by
   7  * the Free Software Foundation with the addition of the following permission
   8  * added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED
   9  * WORK IN WHICH THE COPYRIGHT IS OWNED BY FUNAMBOL, FUNAMBOL DISCLAIMS THE
  10  * WARRANTY OF NON INFRINGEMENT  OF THIRD PARTY RIGHTS.
  11  *
  12  * This program is distributed in the hope that it will be useful, but WITHOUT
  13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  14  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  15  * details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program; if not, see http://www.gnu.org/licenses or write to
  19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  20  * MA 02110-1301 USA.
  21  *
  22  * You can contact Funambol, Inc. headquarters at 643 Bair Island Road, Suite
  23  * 305, Redwood City, CA 94063, USA, or at email address info@funambol.com.
  24  *
  25  * The interactive user interfaces in modified source and object code versions
  26  * of this program must display Appropriate Legal Notices, as required under
  27  * Section 5 of the GNU Affero General Public License version 3.
  28  *
  29  * In accordance with Section 7(b) of the GNU Affero General Public License
  30  * version 3, these Appropriate Legal Notices must retain the display of the
  31  * "Powered by Funambol" logo. If the display of the logo is not reasonably
  32  * feasible for technical reasons, the Appropriate Legal Notices must display
  33  * the words "Powered by Funambol".
  34  */
  35
  36
  37 #ifndef INCL_SOURCE_ARRAY
  38 #define INCL_SOURCE_ARRAY
  39 /** @cond DEV */
  40
  41 #include "base/fscapi.h"
  42 #include "base/util/ArrayElement.h"
  43 #include "syncml/core/Source.h"
  44 #include "base/globalsdef.h"
  45
  46 BEGIN_NAMESPACE
  47
  48
  49 /*
  50 * Class used to create an ArrayList of Source. A Source object is not derived from ArrayElement
  51 * so this wrapper class is used to obtain it.
  52 */
  53 class SourceArray : public ArrayElement {
  54
  55      // ------------------------------------------------------------ Private data
  56     private:
  57
  58         Source* source;
  59
  60     // ---------------------------------------------------------- Protected data
  61     public:
  62
  63         SourceArray();
  64         ~SourceArray();
  65
  66         /**
  67          * Creates a new SourceArray object given the source object
  68          *
  69          */
  70         SourceArray(Source* source);
  71
  72
  73         // ------------------------------------------------------ Public methods
  74
  75         /**
  76          * Returns the source
  77          *
  78          * @return the source
  79          */
  80         Source* getSource();
  81
  82         /**
  83          * Sets the source
  84          *
  85          * @param source the source
  86          *
  87          */
  88         void setSource(Source* source);
  89
  90         ArrayElement* clone();
  91
  92 };
  93
  94
  95 END_NAMESPACE
  96
  97 /** @endcond */
  98 #endif