RDK Documentation (Open Sourced RDK Components)
illegalArgumentException.hpp
Go to the documentation of this file.
1 /*
2  * If not stated otherwise in this file or this component's Licenses.txt file the
3  * following copyright and licenses apply:
4  *
5  * Copyright 2016 RDK Management
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18 */
19 
20 /**
21  * @file illegalArgumentException.hpp
22  * @brief This file defines IllegalArgumentException class to handle exceptions
23  * caused due to illegal argum.
24  */
25 
26 
27 
28 /**
29 * @defgroup devicesettings
30 * @{
31 * @defgroup ds
32 * @{
33 **/
34 
35 
36 #ifndef _DS_ILLEGALARGUMENTEXCEPTION_HPP_
37 #define _DS_ILLEGALARGUMENTEXCEPTION_HPP_
38 
39 #include "exception.hpp"
40 #include <iostream>
41 
42 namespace device {
43 
44 
45 /**
46  * @class IllegalArgumentException
47  * @brief This class extends Exception class to manage the expections caused due to
48  * illegal arguments.
49  * @ingroup devicesettingsclass
50  */
51 class IllegalArgumentException : public device::Exception {
52 public:
53 
54 
55 /**
56  * @fn IllegalArgumentException::IllegalArgumentException(const char *msg = "Illegal Argument")
57  * @brief This function is a parameterised constructor of IllegalArgumentException class. It
58  * initializes the instance with the message passed as input parameter.
59  *
60  * @param[in] msg Indicates the exception message string to be updated.
61  *
62  * @return None
63  */
64  IllegalArgumentException(const char *msg = "Illegal Argument") throw (): device::Exception(msg) {
65  };
66 
67 
68 /**
69  * @fn IllegalArgumentException::~IllegalArgumentException()
70  * @brief This function is a default destructor of the class IllegalArgumentException.
71  *
72  * @return None
73  */
74  virtual ~IllegalArgumentException() throw(){};
75 };
76 
77 }
78 
79 #endif /* ILLEGALARGUMENTEXCEPTION_HPP_ */
80 
81 
82 /** @} */
83 /** @} */
device::IllegalArgumentException::~IllegalArgumentException
virtual ~IllegalArgumentException()
This function is a default destructor of the class IllegalArgumentException.
Definition: illegalArgumentException.hpp:74
device::Exception
This class handles exceptions occurring in DS module.
Definition: exception.hpp:52
device::IllegalArgumentException::IllegalArgumentException
IllegalArgumentException(const char *msg="Illegal Argument")
This function is a parameterised constructor of IllegalArgumentException class. It initializes the in...
Definition: illegalArgumentException.hpp:64
device::IllegalArgumentException
This class extends Exception class to manage the expections caused due to illegal arguments.
Definition: illegalArgumentException.hpp:51