![]() |
Qore reflection Module 1.14.0
|
The abstract base class for Qore class variants. More...
#include <QC_AbstractVariant.dox.h>
Public Member Functions | |
| constructor () | |
| Throws an exception if called directly; this class can only be instantiated by builtin subclasses. | |
| bool | empty () |
| returns True if the variant has no code implementation; False if it does | |
| list< string > | getCodeFlagList () |
| returns a list of strings of code flags describing the variant | |
| int | getCodeFlags () |
| returns a bitfield of code flags describing the variant | |
| list< auto > | getDefaultArgs () |
| returns a list of default arguments for parameters for the variant; if the variant has no parameters, an empty list is returned | |
| int | getDomain () |
| returns the functional domain of the variant (for builtin variants only) as a bitfield of Functional Domain Constants | |
| list< string > | getDomainStringList () |
| returns a list of functional domain strings for the variant (for builtin variants only); an empty list is returned for user variants | |
| AbstractReflectionFunction | getFunction () |
| Returns the abstract function object that contains the variant. | |
| list< string > | getModifierList () |
| returns a list of strings of modifiers describing the variant | |
| int | getModifiers () |
| returns a bitfield of modifiers describing the variant | |
| list< string > | getParamNames () |
| returns a list of parameter variable name for the variant; if the variant has no parameters, an empty list is returned | |
| string | getParamString () |
| returns a string giving a list of the parameters of the variant, including types, variable names, and default values | |
| list< Type > | getParamTypes () |
| returns a list of parameter types for the variant; if the variant has no parameters, an empty list is returned | |
| Type | getReturnType () |
| returns the return type of the variant | |
| string | getReturnTypeString () |
| returns a string for the return type | |
| hash< SourceLocationInfo > | getSourceLocation () |
| Returns the source location of the variant declaration. | |
| bool | hasBody () |
| returns True if the variant has a code implementation; False if not (i.e. it is empty) | |
| bool | isBuiltin () |
| returns True if the variant is a builtin variant | |
| bool | isEqual (AbstractVariant variant) |
| Returns True if the variant passed as an argument is equal to the current object; False if not. | |
| bool | isInjected () |
| returns True if the function or method that the variant belongs to (and therefore the variant itself) has been injected as a dependency injection | |
| bool | isMethodVariant () |
| returns True if the variant is a method variant but not a pseudo-method variant | |
| bool | isPseudoMethodVariant () |
| returns True if the object is a pseudo-method variant | |
| bool | isUser () |
| returns True if the variant is a user variant | |
| int | numParams () |
| returns the number of parameters in the signature | |
| string | toString () |
returns a string for the variant's signature including any modifiers ("synchronized", "private", etc), the return type, the class name (if any, without a namespace prefix and followed by "::"), and the function or method name followed by parameter types in parentheses | |
The abstract base class for Qore class variants.
This class cannot be instantiated directly and also cannot be directly inherited by user-defined classes.
| Qore::Reflection::AbstractVariant::constructor | ( | ) |
Throws an exception if called directly; this class can only be instantiated by builtin subclasses.
| ABSTRACTVARIANT-CONSTRUCTOR-ERROR | this exception is thrown if this class is constructed directly (also if directly inherited by user classes) |
| bool Qore::Reflection::AbstractVariant::empty | ( | ) |
returns True if the variant has no code implementation; False if it does
| PROGRAM-ERROR | thrown if the Program object holding the function or method has been destroyed |
returns a list of strings of code flags describing the variant
"NOOP": the variant has the CF_NOOP flag set"USES_EXTRA_ARGS": the variant has the CF_USES_EXTRA_ARGS flag set"CONSTANT": the variant has the CF_CONSTANT flag set"DEPRECATED": the variant has the CF_DEPRECATED flag set"RET_VALUE_ONLY": the variant has the CF_RET_VALUE_ONLY flag set"RUNTIME_NOOP": the variant has the CF_RUNTIME_NOOP flag set| PROGRAM-ERROR | thrown if the Program object holding the function or method has been destroyed |
| int Qore::Reflection::AbstractVariant::getCodeFlags | ( | ) |
returns a bitfield of code flags describing the variant
| PROGRAM-ERROR | thrown if the Program object holding the function or method has been destroyed |
| list< auto > Qore::Reflection::AbstractVariant::getDefaultArgs | ( | ) |
returns a list of default arguments for parameters for the variant; if the variant has no parameters, an empty list is returned
| PROGRAM-ERROR | thrown if the Program object holding the function or method has been destroyed |
| int Qore::Reflection::AbstractVariant::getDomain | ( | ) |
returns the functional domain of the variant (for builtin variants only) as a bitfield of Functional Domain Constants
| PROGRAM-ERROR | thrown if the Program object holding the function or method has been destroyed |
returns a list of functional domain strings for the variant (for builtin variants only); an empty list is returned for user variants
| PROGRAM-ERROR | thrown if the Program object holding the function or method has been destroyed |
| AbstractReflectionFunction Qore::Reflection::AbstractVariant::getFunction | ( | ) |
Returns the abstract function object that contains the variant.
| PROGRAM-ERROR | thrown if the Program object holding the function or method has been destroyed |
returns a list of strings of modifiers describing the variant
"abstract": the variant is Abstract Methods"final": (only returned for method variants) the variant has the final flag set"private": (only returned for method variants) gives the accessibility of the variant"private:internal": (only returned for method variants) gives the accessibility of the variant"public": for function variants, the variant has the module public flag set on the function, for method variants, this gives the accessibility of the variant"static": (only returned for method variants) the variant is a static method variant"synchronized": the variant is synchronized| PROGRAM-ERROR | thrown if the Program object holding the function or method has been destroyed |
| int Qore::Reflection::AbstractVariant::getModifiers | ( | ) |
returns a bitfield of modifiers describing the variant
| PROGRAM-ERROR | thrown if the Program object holding the function or method has been destroyed |
returns a list of parameter variable name for the variant; if the variant has no parameters, an empty list is returned
| PROGRAM-ERROR | thrown if the Program object holding the function or method has been destroyed |
| string Qore::Reflection::AbstractVariant::getParamString | ( | ) |
returns a string giving a list of the parameters of the variant, including types, variable names, and default values
| PROGRAM-ERROR | thrown if the Program object holding the function or method has been destroyed |
returns a list of parameter types for the variant; if the variant has no parameters, an empty list is returned
| PROGRAM-ERROR | thrown if the Program object holding the function or method has been destroyed |
| Type Qore::Reflection::AbstractVariant::getReturnType | ( | ) |
returns the return type of the variant
| PROGRAM-ERROR | thrown if the Program object holding the function or method has been destroyed |
| string Qore::Reflection::AbstractVariant::getReturnTypeString | ( | ) |
returns a string for the return type
| PROGRAM-ERROR | thrown if the Program object holding the function or method has been destroyed |
| hash< SourceLocationInfo > Qore::Reflection::AbstractVariant::getSourceLocation | ( | ) |
Returns the source location of the variant declaration.
| PROGRAM-ERROR | thrown if the Program object holding the function or method has been destroyed |
| bool Qore::Reflection::AbstractVariant::hasBody | ( | ) |
returns True if the variant has a code implementation; False if not (i.e. it is empty)
| PROGRAM-ERROR | thrown if the Program object holding the function or method has been destroyed |
| bool Qore::Reflection::AbstractVariant::isBuiltin | ( | ) |
returns True if the variant is a builtin variant
| PROGRAM-ERROR | thrown if the Program object holding the function or method has been destroyed |
| bool Qore::Reflection::AbstractVariant::isEqual | ( | AbstractVariant | variant | ) |
Returns True if the variant passed as an argument is equal to the current object; False if not.
| variant | the variant to check with the current object for equality |
| bool Qore::Reflection::AbstractVariant::isInjected | ( | ) |
returns True if the function or method that the variant belongs to (and therefore the variant itself) has been injected as a dependency injection
| PROGRAM-ERROR | thrown if the Program object holding the function or method has been destroyed |
| bool Qore::Reflection::AbstractVariant::isMethodVariant | ( | ) |
returns True if the variant is a method variant but not a pseudo-method variant
| PROGRAM-ERROR | thrown if the Program object holding the function or method has been destroyed |
| bool Qore::Reflection::AbstractVariant::isPseudoMethodVariant | ( | ) |
returns True if the object is a pseudo-method variant
| PROGRAM-ERROR | thrown if the Program object holding the function or method has been destroyed |
| bool Qore::Reflection::AbstractVariant::isUser | ( | ) |
returns True if the variant is a user variant
| PROGRAM-ERROR | thrown if the Program object holding the function or method has been destroyed |
| int Qore::Reflection::AbstractVariant::numParams | ( | ) |
returns the number of parameters in the signature
| PROGRAM-ERROR | thrown if the Program object holding the function or method has been destroyed |
| string Qore::Reflection::AbstractVariant::toString | ( | ) |
returns a string for the variant's signature including any modifiers ("synchronized", "private", etc), the return type, the class name (if any, without a namespace prefix and followed by "::"), and the function or method name followed by parameter types in parentheses
"::"), and the function or method name followed by parameter types in parentheses| PROGRAM-ERROR | thrown if the Program object holding the function or method has been destroyed |