Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.6

Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

TopLevelArg.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 2000-2002 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  * $ Id: $
00058  *
00059  */
00060 
00061 #if !defined(XALAN_TOPLEVELARG_HEADER_GUARD)
00062 #define XALAN_TOPLEVELARG_HEADER_GUARD
00063 
00064 
00065 
00066 
00067 // Base include file.  Must be first.
00068 #include <xalanc/XSLT/XSLTDefinitions.hpp>
00069 
00070 
00071 
00072 #include <xalanc/XalanDOM/XalanDOMString.hpp>
00073 
00074 
00075 
00076 #include <xalanc/XPath/XalanQNameByValue.hpp>
00077 #include <xalanc/XPath/XObject.hpp>
00078 
00079 
00080 
00081 XALAN_CPP_NAMESPACE_BEGIN
00082 
00083 
00084 
00085 class XObjectPtr;
00086 
00087 
00088 
00092 class XALAN_XSLT_EXPORT TopLevelArg
00093 {
00094 public:
00095 
00102     TopLevelArg(
00103         const XalanQName&       name,
00104         const XalanDOMString&   expr);
00105 
00112     TopLevelArg(
00113         const XalanQName&   name = XalanQNameByValue(),
00114         const XObjectPtr    variable = XObjectPtr());
00115 
00121     TopLevelArg(const TopLevelArg&  theSource);
00122 
00126     ~TopLevelArg();
00127 
00133     const XalanQName&
00134     getName() const
00135     {
00136         return m_qname;
00137     }
00138 
00144     const XalanDOMString&
00145     getExpression() const
00146     {
00147         return m_expression;
00148     };
00149 
00155     const XObjectPtr
00156     getXObject() const
00157     {
00158         return m_xobject;
00159     }
00160 
00164     TopLevelArg&
00165     operator=(const TopLevelArg&    theRHS)
00166     {
00167         if (&theRHS != this)
00168         {
00169             m_qname = theRHS.m_qname;
00170 
00171             m_expression = theRHS.m_expression;
00172         }
00173 
00174         return *this;
00175     }
00176 
00177 private:
00178 
00179     XalanQNameByValue   m_qname;
00180 
00181     XalanDOMString      m_expression;
00182 
00183     const XObjectPtr    m_xobject;
00184 };
00185 
00186 
00187 
00188 XALAN_CPP_NAMESPACE_END
00189 
00190 
00191 
00192 #endif  // XALAN_TOPLEVELARG_HEADER_GUARD

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.6
Copyright © 2000, 2001, 2002, 2003 The Apache Software Foundation. All Rights Reserved.