paludis::MetadataKey Class Reference
[Metadata Keys]
#include <metadata_key.hh>
Inheritance diagram for paludis::MetadataKey:
Basic operations | |
| MetadataKey (const std::string &raw_name, const std::string &human_name, const MetadataKeyType) | |
| virtual | ~MetadataKey ()=0 |
Public Member Functions | |
| virtual const std::string | raw_name () const PALUDIS_ATTRIBUTE((warn_unused_result)) |
| virtual const std::string | human_name () const PALUDIS_ATTRIBUTE((warn_unused_result)) |
| virtual MetadataKeyType | type () const PALUDIS_ATTRIBUTE((warn_unused_result)) |
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:
- A raw name. This is in a repository-defined format designed to closely represent the internal name. For example, ebuilds and VDB IDs use raw names like 'DESCRIPTION' and 'KEYWORDS', whereas CRAN uses names like 'Title' and 'BundleDescription'. The raw name is unique in a PackageID or Repository.
- A human name. This is the name that should be used when outputting normally for a human to read.
- A MetadataKeyType. This is a hint to clients as to whether the key should be displayed when outputting information about a package ID or Repository.
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:
Member Function Documentation
| virtual const std::string paludis::MetadataKey::human_name | ( | ) | const [virtual] |
Fetch our human name.
- Examples:
- example_metadata_key.cc.
| virtual const std::string paludis::MetadataKey::raw_name | ( | ) | const [virtual] |
Fetch our raw name.
- Examples:
- example_metadata_key.cc.
| virtual MetadataKeyType paludis::MetadataKey::type | ( | ) | const [virtual] |
Fetch our key type.
- Examples:
- example_metadata_key.cc.
The documentation for this class was generated from the following file:
- /home/users/stephen/scm/paludis/paludis/metadata_key.hh
