MapMessage.h

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef _CMS_MAPMESSAGE_H_
#define _CMS_MAPMESSAGE_H_

#include <cms/Config.h>
#include <cms/Message.h>

#include <cms/CMSException.h>
#include <cms/MessageFormatException.h>
#include <cms/MessageNotWriteableException.h>

namespace cms {

    class CMS_API MapMessage: public Message {
    public:

        virtual ~MapMessage();

        virtual bool isEmpty() const = 0;

        virtual std::vector<std::string> getMapNames() const = 0;

        virtual bool itemExists(const std::string& name) const = 0;

        virtual ValueType getValueType(const std::string& key) const = 0;

        virtual bool getBoolean(const std::string& name) const = 0;

        virtual void setBoolean(const std::string& name, bool value) = 0;

        virtual unsigned char getByte(const std::string& name) const = 0;

        virtual void setByte(const std::string& name, unsigned char value) = 0;

        virtual std::vector<unsigned char> getBytes(const std::string& name) const = 0;

        virtual void setBytes(const std::string& name, const std::vector<unsigned char>& value) = 0;

        virtual char getChar(const std::string& name) const = 0;

        virtual void setChar(const std::string& name, char value) = 0;

        virtual double getDouble(const std::string& name) const = 0;

        virtual void setDouble(const std::string& name, double value) = 0;

        virtual float getFloat(const std::string& name) const = 0;

        virtual void setFloat(const std::string& name, float value) = 0;

        virtual int getInt(const std::string& name) const = 0;

        virtual void setInt(const std::string& name, int value) = 0;

        virtual long long getLong(const std::string& name) const = 0;

        virtual void setLong(const std::string& name, long long value) = 0;

        virtual short getShort(const std::string& name) const = 0;

        virtual void setShort(const std::string& name, short value) = 0;

        virtual std::string getString(const std::string& name) const = 0;

        virtual void setString(const std::string& name, const std::string& value) = 0;

    };

}

#endif /*_CMS_MAPMESSAGE_H_*/