sal/inc/rtl/malformeduriexception.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: malformeduriexception.hxx,v $
  10  * $Revision: 1.4 $
  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
  31 #ifndef INCLUDED_RTL_MALFORMEDURIEXCEPTION_HXX
  32 #define INCLUDED_RTL_MALFORMEDURIEXCEPTION_HXX
  33
  34 #include "rtl/ustring.hxx"
  35
  36 namespace rtl {
  37
  38 /** An exception indicating a malformed URI.
  39
  40     <P>Used when parsing (part of) a URI fails for syntactical reasons.</P>
  41  */
  42 class SAL_EXCEPTION_DLLPUBLIC_EXPORT MalformedUriException
  43 {
  44 public:
  45     /** Create a MalformedUriException.
  46
  47         @param rMessage
  48         A message containing any details about the exception.
  49      */
  50     inline SAL_EXCEPTION_DLLPRIVATE MalformedUriException(
  51         rtl::OUString const & rMessage): m_aMessage(rMessage) {}
  52
  53     inline SAL_EXCEPTION_DLLPRIVATE MalformedUriException(
  54         MalformedUriException const & other): m_aMessage(other.m_aMessage) {}
  55
  56     inline SAL_EXCEPTION_DLLPRIVATE ~MalformedUriException() {}
  57
  58     inline SAL_EXCEPTION_DLLPRIVATE MalformedUriException operator =(
  59         MalformedUriException const & other)
  60     { m_aMessage = other.m_aMessage; return *this; }
  61
  62     /** Get the message.
  63
  64         @return
  65         A reference to the message.  The reference is valid for the lifetime of
  66         this MalformedUriException.
  67      */
  68     inline SAL_EXCEPTION_DLLPRIVATE rtl::OUString const & getMessage() const
  69     { return m_aMessage; }
  70
  71 private:
  72     rtl::OUString m_aMessage;
  73 };
  74
  75 }
  76
  77 #endif // INCLUDED_RTL_MALFORMEDURIEXCEPTION_HXX