Imported Upstream version 0.9.1
[platform/upstream/iotivity.git] / service / things-manager / sdk / java / jni / jniutil / inc / jni_string.h
1 /******************************************************************
2  *
3  * Copyright 2015 Samsung Electronics All Rights Reserved.
4  *
5  *
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 /**
22   * @file   jni_string.h
23   *
24   * @brief  This file contains the declaration of JString class and its members related to JString.
25   *
26 */
27
28 #ifndef __JNI_STRING_H_
29 #define __JNI_STRING_H_
30
31
32 #include <string>
33
34 #include "jni_object.h"
35
36 /**
37  * @class   JString
38  * @brief   This class inherits JObject class and provides a set of functions for JNI String.
39  *
40  */
41 class JString : public JObject
42 {
43     public:
44         /**
45          * @brief constructor
46          */
47         JString(JNIEnv *env, jstring value);
48         /**
49          * @brief constructor
50          */
51         JString(JNIEnv *env, const char *value);
52         /**
53          * @brief constructor
54          */
55         JString(JNIEnv *env, const std::string &value);
56         /**
57          * @brief destructor
58          */
59         ~JString();
60
61         /**
62          * Function to get the string value and set it.
63          *
64          * @param value - String value to set to a private member variable.
65          *
66          * @return bool - true on success
67          *
68          */
69         bool getValue(std::string &value);
70
71         /**
72          * Function to get the private string value.
73          *
74          * @return  C String value.
75          *
76          */
77         const char *c_str();
78
79     private:
80         std::string m_cstr;
81 };
82 #endif //__JNI_STRING_H_