class Poco::Util::OptionSet

Overview

A collection of Option objects. More…

#include <OptionSet.h>

class OptionSet
{
public:
    // typedefs

    typedef std::vector<Option> OptionVec;
    typedef OptionVec::const_iterator Iterator;

    // construction

    OptionSet();
    OptionSet(const OptionSet& options);

    // methods

    OptionSet&
    operator=(const OptionSet& options);

    void
    addOption(const Option& option);

    bool
    hasOption(
        const std::string& name,
        bool matchShort = false
        ) const;

    const Option&
    getOption(
        const std::string& name,
        bool matchShort = false
        ) const;

    Iterator
    begin() const;

    Iterator
    end() const;
};

Detailed Documentation

A collection of Option objects.

Construction

OptionSet()

Creates the OptionSet.

OptionSet(const OptionSet& options)

Creates an option set from another one.

Methods

OptionSet&
operator=(const OptionSet& options)

Assignment operator.

void
addOption(const Option& option)

Adds an option to the collection.

bool
hasOption(
    const std::string& name,
    bool matchShort = false
    ) const

Returns a true iff an option with the given name exists.

The given name can either be a fully specified short name, or a partially specified full name. If a partial name matches more than one full name, false is returned. The name must either match the short or full name of an option. Comparison case sensitive for the short name and not case sensitive for the full name.

const Option&
getOption(
    const std::string& name,
    bool matchShort = false
    ) const

Returns a reference to the option with the given name.

The given name can either be a fully specified short name, or a partially specified full name. The name must either match the short or full name of an option. Comparison case sensitive for the short name and not case sensitive for the full name. Throws a NotFoundException if no matching option has been found. Throws an UnknownOptionException if a partial full name matches more than one option.

Iterator
begin() const

Supports iterating over all options.

Iterator
end() const

Supports iterating over all options.