CharValue.h

00001 /*
00002  * CharValue.h
00003  *
00004  * Created on: Nov 1, 2013
00005  * * Authors: Vincent Wochnik <v.wochnik@gmail.com>
00006  *
00007  * Copyright (c) 2013 Cumulocity GmbH
00008  *
00009  * Permission is hereby granted, free of charge, to any person obtaining
00010  * a copy of this software and associated documentation files (the
00011  * "Software"), to deal in the Software without restriction, including
00012  * without limitation the rights to use, copy, modify, merge, publish,
00013  * distribute, sublicense, and/or sell copies of the Software, and to
00014  * permit persons to whom the Software is furnished to do so, subject to
00015  * the following conditions:
00016  *
00017  * The above copyright notice and this permission notice shall be
00018  * included in all copies or substantial portions of the Software.
00019  *
00020  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
00021  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00022  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
00023  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
00024  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
00025  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
00026  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
00027  */
00028 
00029 #ifndef CHARVALUE_H
00030 #define CHARVALUE_H
00031 
00032 #include "config.h"
00033 #include "Value.h"
00034 
00035 /**
00036  * A basic character value. This value type behaves simmilar to a null
00037  * value if the ommitted string is empty.
00038  * 
00039  * Example:
00040  * @code
00041  * // A string
00042  * CharValue str("Hello World!");
00043  * 
00044  * // a null value
00045  * CharValue null("");
00046  * 
00047  * // another null value
00048  * CharValue null2(NULL);
00049  * @encode
00050  */
00051 class CharValue : public Value
00052 {
00053     public:
00054         CharValue(const char*, bool = false);
00055         virtual ~CharValue();
00056 
00057         virtual uint8_t valueType() const;
00058         virtual long integerValue() const;
00059         virtual double floatValue() const;
00060         virtual const char * characterValue() const;
00061 
00062         virtual size_t write(AbstractDataSink&) const;
00063         virtual size_t length() const;
00064         virtual Value* copy() const;
00065 
00066     protected:
00067         bool escapeCheck();
00068 
00069     private:
00070         const char *_str;
00071         bool _escape, _alloc;
00072 };
00073 
00074 #endif