#include <Options.h>

Inheritance diagram for Acl::Option:
Collaboration diagram for Acl::Option:

Public Types

enum  ValueExpectation {
  valueNone,
  valueOptional,
  valueRequired
}
 

Public Member Functions

 Option (ValueExpectation vex=valueNone)
 
virtual ~Option ()
 
virtual bool configured () const =0
 
virtual void configureDefault () const =0
 called after parsing -x or –name More...
 
virtual void configureWith (const SBuf &rawValue) const =0
 called after parsing -x=value or –name=value More...
 
virtual bool valued () const =0
 
virtual void print (std::ostream &os) const =0
 prints a configuration snippet (as an admin could have typed) More...
 

Public Attributes

ValueExpectation valueExpectation = valueNone
 expect "=value" part? More...
 

Detailed Description

A single option supported by an ACL: -x[=value] or –name[=value] Unlike a parameter flag, this option applies to all ACL parameters.

Definition at line 39 of file Options.h.

Member Enumeration Documentation

Enumerator
valueNone 
valueOptional 
valueRequired 

Definition at line 42 of file Options.h.

Constructor & Destructor Documentation

Acl::Option::Option ( ValueExpectation  vex = valueNone)
inlineexplicit

Definition at line 43 of file Options.h.

virtual Acl::Option::~Option ( )
inlinevirtual

Definition at line 44 of file Options.h.

Member Function Documentation

virtual bool Acl::Option::configured ( ) const
pure virtual

whether the admin explicitly specified this option (i.e., whether configureWith() or configureDefault() has been called)

Implemented in Acl::TypedOption< Recipient >, and Acl::TypedOption< CharacterSetOptionValue >.

Referenced by Acl::OptionsParser::parse().

virtual void Acl::Option::configureDefault ( ) const
pure virtual
virtual void Acl::Option::configureWith ( const SBuf rawValue) const
pure virtual
virtual void Acl::Option::print ( std::ostream &  os) const
pure virtual
virtual bool Acl::Option::valued ( ) const
pure virtual

Member Data Documentation

ValueExpectation Acl::Option::valueExpectation = valueNone

Definition at line 61 of file Options.h.

Referenced by Acl::OptionsParser::parse().


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

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors