src/main/cms/CMSProperties.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_CMSPROPERTIES_H_
#define _CMS_CMSPROPERTIES_H_

#include <cms/Config.h>

#include <map>
#include <string>
#include <vector>

namespace cms{

    class CMS_API CMSProperties {
    public:

        virtual ~CMSProperties() throw();

        virtual int size() const = 0;

        virtual bool isEmpty() const = 0;

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

        virtual std::string getProperty( const std::string& name,
                                         const std::string& defaultValue ) const = 0;

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

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

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

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

        virtual std::vector< std::pair< std::string, std::string > > toArray() const = 0;

        virtual void copy( const CMSProperties* source ) = 0;

        virtual CMSProperties* clone() const = 0;

        virtual void clear() = 0;

        virtual std::string toString() const = 0;

   };

}

#endif /*_CMS_CMSPROPERTIES_H_*/