Base Framework
Public Types | Public Member Functions | List of all members
ArgumentParser::Option Class Reference

Inherits ReferenceCountedObject.

Inherited by ArgumentParser::BooleanOption, ArgumentParser::CardinalOption, ArgumentParser::EnumOption, ArgumentParser::FlagOption, ArgumentParser::RealOption, ArgumentParser::RegExpOption, and ArgumentParser::StringOption.

Public Types

enum  Flag {
  MANDATORY = 1, STRICT = 2, DEPRECATED = 4, EXPLICIT = 8,
  OVERRIDE = 16
}
 

Public Member Functions

 Option (const String &name, unsigned int flags=0)
 
 Option (const String &name, char shortName, unsigned int flags=0)
 
bool hasShortName () const noexcept
 
char getShortName () const noexcept
 
const StringgetName () const noexcept
 
unsigned int getFlags () const noexcept
 
- Public Member Functions inherited from ReferenceCountedObject
 ReferenceCountedObject () noexcept
 
 ReferenceCountedObject (const ReferenceCountedObject &copy) noexcept
 
 ReferenceCountedObject (ReferenceCountedObject &&move) noexcept
 
ReferenceCountedObjectoperator= (const ReferenceCountedObject &copy) noexcept
 
ReferenceCountedObjectoperator= (ReferenceCountedObject &&move) noexcept
 
MemorySize getNumberOfReferences_INTERNAL () const noexcept
 
virtual bool useGarbageCollector () const noexcept
 
- Public Member Functions inherited from DynamicObject
 DynamicObject () noexcept
 
bool isValidObject () const noexcept
 
virtual ~DynamicObject () noexcept(false)
 
 _COM_AZURE_DEV__BASE__OVERRIDE_ALLOC ()
 

Member Enumeration Documentation

◆ Flag

Enumerator
MANDATORY 

Option is required.

STRICT 

Option must be occur at most once.

DEPRECATED 

Option is deprecated.

EXPLICIT 

Value must be given if option is specified.

OVERRIDE 

The last occurrence is the only significant.

Member Function Documentation

◆ getFlags()

unsigned int ArgumentParser::Option::getFlags ( ) const
inlinenoexcept

Returns the flags.

◆ getName()

const String& ArgumentParser::Option::getName ( ) const
inlinenoexcept

Returns the long name of the option.

◆ getShortName()

char ArgumentParser::Option::getShortName ( ) const
inlinenoexcept

Returns the short name of the option.

◆ hasShortName()

bool ArgumentParser::Option::hasShortName ( ) const
inlinenoexcept

Returns true if the option has a short name.