Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.7

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

XalanMessageLoader.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 1999-2004 The Apache Software Foundation.  All rights 
00006  * reserved.
00007  *
00008  * Redistribution and use in source and binary forms, with or without
00009  * modification, are permitted provided that the following conditions
00010  * are met:
00011  *
00012  * 1. Redistributions of source code must retain the above copyright
00013  *    notice, this list of conditions and the following disclaimer. 
00014  *
00015  * 2. Redistributions in binary form must reproduce the above copyright
00016  *    notice, this list of conditions and the following disclaimer in
00017  *    the documentation and/or other materials provided with the
00018  *    distribution.
00019  *
00020  * 3. The end-user documentation included with the redistribution,
00021  *    if any, must include the following acknowledgment:  
00022  *       "This product includes software developed by the
00023  *        Apache Software Foundation (http://www.apache.org/)."
00024  *    Alternately, this acknowledgment may appear in the software itself,
00025  *    if and wherever such third-party acknowledgments normally appear.
00026  *
00027  * 4. The names "Xalan" and "Apache Software Foundation" must
00028  *    not be used to endorse or promote products derived from this
00029  *    software without prior written permission. For written 
00030  *    permission, please contact apache@apache.org.
00031  *
00032  * 5. Products derived from this software may not be called "Apache",
00033  *    nor may "Apache" appear in their name, without prior written
00034  *    permission of the Apache Software Foundation.
00035  *
00036  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00037  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00038  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00039  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00040  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00041  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00042  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00043  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00044  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00045  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00046  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00047  * SUCH DAMAGE.
00048  * ====================================================================
00049  *
00050  * This software consists of voluntary contributions made by many
00051  * individuals on behalf of the Apache Software Foundation and was
00052  * originally based on software copyright (c) 1999, International
00053  * Business Machines, Inc., http://www.ibm.com.  For more
00054  * information on the Apache Software Foundation, please see
00055  * <http://www.apache.org/>.
00056  */
00057 #if !defined(XALANMESSAGELOADER_HEADER_GUARD_1357924680)
00058 #define XALANMESSAGELOADER_HEADER_GUARD_1357924680
00059 
00060 
00061 // Base include file.  Must be first.
00062 #include <xalanc/PlatformSupport/PlatformSupportDefinitions.hpp>
00063 
00064 
00065 #include <xalanc/XalanDOM/XalanDOMString.hpp>
00066 
00067 #include <LocalMsgIndex.hpp>
00068 
00069 
00070 XALAN_CPP_NAMESPACE_BEGIN
00071 
00072 
00073 
00074 // class for calling fom outside of the module 
00075 class  XALAN_PLATFORMSUPPORT_EXPORT XalanMessageLoader {
00076 
00077 
00078 public:
00079 
00080     
00081     // -----------------------------------------------------------------------
00082     //  Public Constructors and Destructor
00083     // -----------------------------------------------------------------------
00084     virtual
00085     ~XalanMessageLoader();
00086 
00087     XalanMessageLoader()
00088     {
00089     }
00090 
00091     static void
00092     createLoader();
00093 
00094     static void
00095     destroyLoader();
00096 
00097     static const XalanDOMString
00098     getMessage(XalanMessages::Codes     msgToLoad
00099         , const char*           repText1 
00100         , const char*           repText2 = 0
00101         , const char*           repText3 = 0
00102         , const char*           repText4 = 0);
00103 
00104     static const XalanDOMString
00105     getMessage(XalanMessages::Codes     msgToLoad
00106         , const XalanDOMChar*           repText1 
00107         , const XalanDOMChar*           repText2 = 0
00108         , const XalanDOMChar*           repText3 = 0
00109         , const XalanDOMChar*           repText4 = 0);
00110 
00111     static const XalanDOMString
00112     getMessage(XalanMessages::Codes     msgToLoad);
00113 
00114     static const XalanDOMString
00115     getMessage(XalanMessages::Codes     msgToLoad
00116         , const XalanDOMString&                 repText1 );
00117 
00118     static const XalanDOMString
00119     getMessage(XalanMessages::Codes     msgToLoad
00120         , const XalanDOMString&                 repText1 
00121         , const XalanDOMString&                 repText2 );
00122 
00123     static const XalanDOMString
00124     getMessage(XalanMessages::Codes     msgToLoad
00125         , const XalanDOMString&                 repText1 
00126         , const XalanDOMString&                 repText2 
00127         , const XalanDOMString&                 repText3);
00128 
00129 protected:
00130     virtual bool loadMsg
00131         (
00132           XalanMessages::Codes      msgToLoad
00133         , XalanDOMChar*             toFill
00134         , unsigned int              maxChars
00135         ) =0;
00136 
00137 private:
00138 
00139     bool load
00140         (
00141         XalanMessages::Codes        msgToLoad
00142         , XalanDOMChar*             toFill
00143         , unsigned int              maxChars
00144         , const XalanDOMChar*       repText1 
00145         , const XalanDOMChar*       repText2 = 0
00146         , const XalanDOMChar*       repText3 = 0
00147         , const XalanDOMChar*       repText4 = 0
00148         );
00149     
00150     bool load
00151         (
00152         XalanMessages::Codes        msgToLoad
00153         , XalanDOMChar*             toFill
00154         , unsigned int              maxChars
00155         , const char*               repText1 
00156         , const char*               repText2 = 0
00157         , const char*               repText3 = 0
00158         , const char*               repText4 = 0
00159         );
00160 
00161     XalanMessageLoader(const XalanMessageLoader&);
00162 
00163     XalanMessageLoader&
00164     operator=(const XalanMessageLoader&);
00165 
00166     static XalanMessageLoader*  s_msgLoader;
00167 };
00168 
00169 
00170 
00171 XALAN_CPP_NAMESPACE_END
00172 
00173 #endif  // XALANMESSAGELOADER_HEADER_GUARD_1357924680

Interpreting class diagrams

Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.

Xalan-C++ XSLT Processor Version 1.7
Copyright © 1999-2004 The Apache Software Foundation. All Rights Reserved.