paludis::MetadataKey Class Reference
[Metadata Keys]

#include <metadata_key.hh>

Inheritance diagram for paludis::MetadataKey:

paludis::MetadataCollectionKey< C_ > paludis::MetadataCollectionKey< paludis::Sequence > paludis::MetadataCollectionKey< paludis::Sequence< std::string > > paludis::MetadataCollectionKey< paludis::Set< std::string > > paludis::MetadataSectionKey paludis::MetadataSpecTreeKey< C_ > paludis::MetadataSpecTreeKey< DependencySpecTree > paludis::MetadataSpecTreeKey< FetchableURISpecTree > paludis::MetadataTimeKey paludis::MetadataValueKey< C_ > paludis::MetadataValueKey< std::tr1::shared_ptr< paludis::Choices > > paludis::MetadataValueKey< T_ >

List of all members.

Basic operations

virtual ~MetadataKey ()=0

Public Member Functions

virtual const std::string raw_name () const PALUDIS_ATTRIBUTE((warn_unused_result))=0
virtual const std::string human_name () const PALUDIS_ATTRIBUTE((warn_unused_result))=0
virtual MetadataKeyType type () const PALUDIS_ATTRIBUTE((warn_unused_result))=0


Detailed Description

A MetadataKey is a generic key that contains a particular piece of information about a PackageID or Repository instance.

A basic MetadataKey has:

Subclasses provide additional information, including the 'value' of the key. A ConstVisitor using MetadataKeyVisitorTypes can be used to get more detail.

The header literal_metadata_key.hh contains various concrete implementations of MetadataKey subclasses.

Since:
0.26
Examples:

example_metadata_key.cc.


Member Function Documentation

virtual const std::string paludis::MetadataKey::raw_name (  )  const [pure virtual]

Fetch our raw name.

Implemented in paludis::LiteralMetadataValueKey< T_ >, paludis::LiteralMetadataFSEntrySequenceKey, paludis::LiteralMetadataStringSetKey, paludis::LiteralMetadataStringSequenceKey, and paludis::LiteralMetadataTimeKey.

Examples:
example_metadata_key.cc.

virtual const std::string paludis::MetadataKey::human_name (  )  const [pure virtual]

Fetch our human name.

Implemented in paludis::LiteralMetadataValueKey< T_ >, paludis::LiteralMetadataFSEntrySequenceKey, paludis::LiteralMetadataStringSetKey, paludis::LiteralMetadataStringSequenceKey, and paludis::LiteralMetadataTimeKey.

Examples:
example_metadata_key.cc.

virtual MetadataKeyType paludis::MetadataKey::type (  )  const [pure virtual]

Fetch our key type.

Implemented in paludis::LiteralMetadataValueKey< T_ >, paludis::LiteralMetadataFSEntrySequenceKey, paludis::LiteralMetadataStringSetKey, paludis::LiteralMetadataStringSequenceKey, and paludis::LiteralMetadataTimeKey.

Examples:
example_metadata_key.cc.


The documentation for this class was generated from the following file:
Generated on Mon Sep 21 10:36:10 2009 for paludis by  doxygen 1.5.4