Properties.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 _DECAF_UTIL_PROPERTIES_H_
#define _DECAF_UTIL_PROPERTIES_H_

#include <vector>
#include <string>
#include <decaf/util/Config.h>
#include <decaf/util/StlMap.h>
#include <decaf/io/InputStream.h>
#include <decaf/io/OutputStream.h>
#include <decaf/lang/Pointer.h>
#include <decaf/lang/exceptions/IllegalArgumentException.h>
#include <decaf/lang/exceptions/NullPointerException.h>
#include <decaf/io/IOException.h>

namespace decaf{
namespace io{
    class Reader;
    class Writer;
}
namespace util{

    class PropertiesInternal;

    class DECAF_API Properties{
    private:

        PropertiesInternal* internal;

    protected:

        decaf::lang::Pointer<Properties> defaults;

    public:

        Properties();

        Properties( const Properties& src );

        virtual ~Properties();

        Properties& operator= ( const Properties& src );

        bool isEmpty() const;

        int size() const;

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

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

        std::string setProperty( const std::string& name, const std::string& value );

        bool hasProperty( const std::string& name ) const;

        std::string remove( const std::string& name );

        std::vector<std::string> propertyNames() const;

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

        void copy( const Properties& source );

        Properties* clone() const;

        void clear();

        bool equals( const Properties& source ) const;

        std::string toString() const;

        void load( decaf::io::InputStream* stream );

        void load( decaf::io::Reader* reader );

        void store( decaf::io::OutputStream* out, const std::string& comment );

        void store( decaf::io::Writer* writer, const std::string& comments );

    private:

        void selectProperties( decaf::util::StlMap<std::string, std::string>& selectProperties ) const;

    };

}}

#endif /*_DECAF_UTIL_PROPERTIES_H_*/