Module Class Reference

#include <base/Module.h>

Inherits ReferenceCountedObject.

Public Types
enum	Impact { PRIVACY = 1 << 0, SECURITY = 1 << 1, CRITICAL = 1 << 2, COSMETIC = 1 << 31 }

Public Member Functions
	Module ()
void	setId (const String &id)
void	setUrl (const String &url)
void	setConsumer (const String &consumer)
void	setLicense (const String &license)
void	setDescription (const String &description)
const String &	getId () const noexcept
const String &	getUrl () const noexcept
const String &	getConsumer () const noexcept
const String &	getLicense () const noexcept
const String &	getDescription () const noexcept
Public Member Functions inherited from ReferenceCountedObject
	ReferenceCountedObject () noexcept
	ReferenceCountedObject (const ReferenceCountedObject &copy) noexcept
	ReferenceCountedObject (ReferenceCountedObject &&move) noexcept
ReferenceCountedObject &	operator= (const ReferenceCountedObject &copy) noexcept
ReferenceCountedObject &	operator= (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 ()

Static Public Member Functions
static bool	isFullyQualifiedId (const String &id) noexcept
static bool	isValidConsumer (const String &consumer) noexcept
static bool	isValidPrefix (const String &prefix) noexcept
static bool	isValidName (const String &name) noexcept
static bool	isValidVersion (const String &version) noexcept
static int	compareVersions (const String &a, const String &b) noexcept

Detailed Description

Module.

Constructor & Destructor Documentation

Module()

Module::Module

(

)

Initializes the module.

Member Function Documentation

compareVersions()

static int Module::compareVersions ( const String &  a, const String &  b  )

staticnoexcept

Compares the given versions.

getConsumer()

const String& Module::getConsumer ( ) const

inlinenoexcept

Returns the consumer module of the module.

getDescription()

const String& Module::getDescription ( ) const

inlinenoexcept

Returns the description of the module.

getId()

const String& Module::getId ( ) const

inlinenoexcept

Returns the fully qualified id (PREFIX:NAME:VERSION) of the module.

getLicense()

const String& Module::getLicense ( ) const

inlinenoexcept

Returns the license of the module.

getUrl()

const String& Module::getUrl ( ) const

inlinenoexcept

Returns the url of the module.

isFullyQualifiedId()

static bool Module::isFullyQualifiedId ( const String &  id )

staticnoexcept

Returns true if the name is valid ID => (PREFIX:NAME:VERSION).

isValidConsumer()

static bool Module::isValidConsumer ( const String &  consumer )

staticnoexcept

Returns true if the consumer is valid CONSUMER => (PREFIX:NAME).

isValidName()

static bool Module::isValidName ( const String &  name )

staticnoexcept

Returns true if the name is valid NAME => ([a-zA-Z0-9_]+).

isValidPrefix()

static bool Module::isValidPrefix ( const String &  prefix )

staticnoexcept

Returns true if the prefix is valid PREFIX => (Guid || ([a-zA-Z0-9_]+(.[a-zA-Z0-9_]+)*)).

isValidVersion()

static bool Module::isValidVersion ( const String &  version )

staticnoexcept

Returns true if the version is valid. VERSION => ((0 || [1-9][0-9]*)(.(0 || [1-9][0-9]*))*).

setConsumer()

void Module::setConsumer

(

const String &

consumer

)

Sets the consumer file of the module.

setDescription()

void Module::setDescription

(

const String &

description

)

Sets the description of the module.

setId()

void Module::setId

(

const String &

id

)

Sets the id of the module.

setLicense()

void Module::setLicense

(

const String &

license

)

Sets the license of the module.

setUrl()

void Module::setUrl

(

const String &

url

)

Sets the url for the module.