service/easy-setup/sdk/mediator/android/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 #include <string>
  32
  33 #include "jni_object.h"
  34
  35 /**
  36  * @class   JString
  37  * @brief   This class inherits JObject class and provides a set of functions for JNI String.
  38  *
  39  */
  40 class JString: public JObject {
  41 public:
  42         /**
  43          * @brief constructor
  44          */
  45         JString(JNIEnv *env, jstring value);
  46         /**
  47          * @brief constructor
  48          */
  49         JString(JNIEnv *env, const char *value);
  50         /**
  51          * @brief constructor
  52          */
  53         JString(JNIEnv *env, const std::string &value);
  54         /**
  55          * @brief destructor
  56          */
  57         ~JString();
  58
  59         /**
  60          * Function to get the string value and set it.
  61          *
  62          * @param value - String value to set to a private member variable.
  63          *
  64          * @return bool - true on success
  65          *
  66          */
  67         bool getValue(std::string &value);
  68
  69         /**
  70          * Function to get the private string value.
  71          *
  72          * @return  C String value.
  73          *
  74          */
  75         const char *c_str();
  76
  77 private:
  78         std::string m_cstr;
  79 };
  80 #endif //__JNI_STRING_H_