paludis  Version 2.6.0
Protected Member Functions | List of all members
paludis::MetadataKeyHolder Class Referenceabstract

#include <metadata_key_holder.hh>

+ Inheritance diagram for paludis::MetadataKeyHolder:

Protected Member Functions

virtual void add_metadata_key (const std::shared_ptr< const MetadataKey > &) const
virtual void clear_metadata_keys () const
virtual void need_keys_added () const =0

Finding and iterating over metadata keys

typedef WrappedForwardIterator< MetadataConstIteratorTag, const std::shared_ptr< const MetadataKey > > MetadataConstIterator
MetadataConstIterator begin_metadata () const PALUDIS_ATTRIBUTE((warn_unused_result))
MetadataConstIterator end_metadata () const PALUDIS_ATTRIBUTE((warn_unused_result))
MetadataConstIterator find_metadata (const std::string &) const PALUDIS_ATTRIBUTE((warn_unused_result))

Detailed Description

Generic interface for any class that holds a number of MetadataKey instances.


Member Function Documentation

virtual void paludis::MetadataKeyHolder::add_metadata_key ( const std::shared_ptr< const MetadataKey > &  ) const

Add a new MetadataKey, which must not use the same raw name as any previous MetadataKey added to this ID.

virtual void paludis::MetadataKeyHolder::clear_metadata_keys ( ) const

Clear all MetadataKey instances added using add_metadata_key.

virtual void paludis::MetadataKeyHolder::need_keys_added ( ) const
protectedpure virtual

This method will be called before any of the metadata key iteration methods does its work. It can be used by subclasses to implement as-needed loading of keys.

Implemented in paludis::FakePackageID, paludis::ContentsEntry, paludis::AboutMetadata, paludis::FakeRepositoryBase, and paludis::TestEnvironment.

The documentation for this class was generated from the following file: