include/rtl/malformeduriexception.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_RTL_MALFORMEDURIEXCEPTION_HXX
  21 #define INCLUDED_RTL_MALFORMEDURIEXCEPTION_HXX
  22
  23 #include "rtl/ustring.hxx"
  24
  25 namespace rtl {
  26
  27 /** An exception indicating a malformed URI.
  28
  29     <P>Used when parsing (part of) a URI fails for syntactical reasons.</P>
  30  */
  31 class SAL_EXCEPTION_DLLPUBLIC_EXPORT MalformedUriException
  32 {
  33 public:
  34     /** Create a MalformedUriException.
  35
  36         @param rMessage
  37         A message containing any details about the exception.
  38      */
  39     SAL_EXCEPTION_DLLPRIVATE MalformedUriException(
  40         rtl::OUString const & rMessage): m_aMessage(rMessage) {}
  41
  42     SAL_EXCEPTION_DLLPRIVATE MalformedUriException(
  43         MalformedUriException const & other): m_aMessage(other.m_aMessage) {}
  44
  45     SAL_EXCEPTION_DLLPRIVATE ~MalformedUriException() {}
  46
  47     SAL_EXCEPTION_DLLPRIVATE MalformedUriException operator =(
  48         MalformedUriException const & rOther)
  49     { m_aMessage = rOther.m_aMessage; return *this; }
  50
  51     /** Get the message.
  52
  53         @return
  54         A reference to the message.  The reference is valid for the lifetime of
  55         this MalformedUriException.
  56      */
  57     SAL_EXCEPTION_DLLPRIVATE rtl::OUString const & getMessage() const
  58     { return m_aMessage; }
  59
  60 private:
  61     rtl::OUString m_aMessage;
  62 };
  63
  64 }
  65
  66 #endif // INCLUDED_RTL_MALFORMEDURIEXCEPTION_HXX
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */