http://xml.apache.org/http://www.apache.org/http://www.w3.org/

Home

Readme
Installation
Build

API Docs
Samples
Programming
Migration
FAQs

Releases
Feedback

PDF Document

Download
Dev Snapshots
CVS Repository
Mail Archive

API Docs for SAX and DOM
 

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

KVStringPair.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: KVStringPair.hpp,v $
00059  * Revision 1.4  2000/03/02 19:54:40  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:24  abagchi
00065  * Swat for removing Log from API docs
00066  *
00067  * Revision 1.2  2000/02/06 07:48:02  rahulj
00068  * Year 2K copyright swat.
00069  *
00070  * Revision 1.1.1.1  1999/11/09 01:04:37  twl
00071  * Initial checkin
00072  *
00073  * Revision 1.2  1999/11/08 20:45:08  rahul
00074  * Swat for adding in Product name and CVS comment log variable.
00075  *
00076  */
00077 
00078 #if !defined(KVSTRINGPAIR_HPP)
00079 #define KVSTRINGPAIR_HPP
00080 
00081 #include <util/XercesDefs.hpp>
00082 
00083 
00084 //
00085 //  This class provides a commonly used data structure, which is that of
00086 //  a pair of strings which represent a 'key=value' type mapping. It works
00087 //  only in terms of XMLCh type raw strings.
00088 //
00089 class  KVStringPair
00090 {
00091 public:
00092     // -----------------------------------------------------------------------
00093     //  Constructors and Destructor
00094     // -----------------------------------------------------------------------
00095     KVStringPair();
00096     KVStringPair(const XMLCh* const key, const XMLCh* const value);
00097     KVStringPair(const KVStringPair& toCopy);
00098     ~KVStringPair();
00099 
00100 
00101     // -----------------------------------------------------------------------
00102     //  Getters
00103     //
00104     //  We support the 
00105     // -----------------------------------------------------------------------
00106     const XMLCh* getKey() const;
00107     XMLCh* getKey();
00108     const XMLCh* getValue() const;
00109     XMLCh* getValue();
00110 
00111 
00112     // -----------------------------------------------------------------------
00113     //  Setters
00114     // -----------------------------------------------------------------------
00115     void setKey(const XMLCh* const newKey);
00116     void setValue(const XMLCh* const newValue);
00117     void set
00118     (
00119         const   XMLCh* const    newKey
00120         , const XMLCh* const    newValue
00121     );
00122 
00123 
00124 private :
00125     // -----------------------------------------------------------------------
00126     //  Private data members
00127     //
00128     //  fKey
00129     //      The string that represents the key field of this object.
00130     //
00131     //  fValue
00132     //      The string that represents the value of this pair object.
00133     // -----------------------------------------------------------------------
00134     XMLCh*  fKey;
00135     XMLCh*  fValue;
00136 };
00137 
00138 #endif


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