PropertiesInterface.h

Go to the documentation of this file.

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *     http://aws.amazon.com/apache2.0/
 *
 * or in the "license" file accompanying this file. This file 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 ACSDK_PROPERTIESINTERFACES_PROPERTIESINTERFACE_H_
#define ACSDK_PROPERTIESINTERFACES_PROPERTIESINTERFACE_H_

#include <string>
#include <unordered_set>
#include <vector>

namespace alexaClientSDK {
namespace propertiesInterfaces {


class PropertiesInterface {
public:
    typedef std::vector<unsigned char> Bytes;

    virtual ~PropertiesInterface() noexcept = default;


    virtual bool getString(const std::string& key, std::string& value) noexcept = 0;


    virtual bool putString(const std::string& key, const std::string& value) noexcept = 0;


    virtual bool getBytes(const std::string& key, Bytes& value) noexcept = 0;


    virtual bool putBytes(const std::string& key, const Bytes& value) noexcept = 0;


    virtual bool getKeys(std::unordered_set<std::string>& keys) noexcept = 0;


    virtual bool remove(const std::string& key) noexcept = 0;


    virtual bool clear() noexcept = 0;
};

}  // namespace propertiesInterfaces
}  // namespace alexaClientSDK

#endif  // ACSDK_PROPERTIESINTERFACES_PROPERTIESINTERFACE_H_