Qore::Reflection::AbstractMethod Class Reference

The abstract base class for Qore class methods. More...

#include <QC_AbstractMethod.dox.h>

Inheritance diagram for Qore::Reflection::AbstractMethod:

Public Member Methods
	constructor ()
	Throws an exception if called directly; this class can only be instantiated by builtin subclasses. More...
AbstractClass	getClass ()
	Returns the class for the method. More...
string	getMethodTypeName ()
	returns the type of method as a string; one of "normal", "static", "constructor", "destructor", "copy" More...
AbstractMethodVariant	getVariant (...)
	Returns the given direct child method variant declared in this method or throws an exception if the method variant is not defined. More...
AbstractMethodVariant	getVariantArgs (softlist< Type > argv)
	Returns the given direct child method variant declared in this method or throws an exception if the method variant is not defined. More...
list< AbstractMethodVariant >	getVariants ()
	returns the variants implemented by the method More...
bool	isStatic ()
	returns True if the method is a static method More...
Public Member Methods inherited from Qore::Reflection::AbstractReflectionFunction
	constructor ()
	Throws an exception if called directly; this class can only be instantiated by builtin subclasses. More...
list< string >	getCodeFlagList ()
	returns a list of strings of code flags common to all variants for this function More...
int	getCodeFlags ()
	returns a bitfield of code flags common to all variants for this function More...
int	getDomain ()
	returns the functional domain common to all variants for this function (for builtin functions only) as a bitfield of functional_domain_constants More...
list< string >	getDomainStringList ()
	returns a list of functional domain strings common to all variants for this function (for builtin functions only); an empty list is returned for user functions More...
*string	getModuleName ()
	Returns the module name providing the function or method or nothing if the function or method was not provided by a module. More...
string	getName ()
	returns the function or method name More...
bool	isBuiltin ()
	returns True if the function or method is a builtin function or method More...
bool	isEqual (AbstractReflectionFunction func)
	Returns True if the function or method object passed as an argument is equal to the current object; False if not. More...
bool	isInjected ()
	returns True if the function or method has been injected as a dependency injection More...
bool	isMethod ()
	returns True if the object is a method but not a pseudo-method More...
bool	isPseudoMethod ()
	returns True if the object is a pseudo-method More...
bool	isUser ()
	returns True if the function or method is a user function or method More...
int	numVariants ()
	returns the number of variants implemented by the function or method More...

Detailed Description

The abstract base class for Qore class methods.

Restrictions:

Qore::PO_NO_REFLECTION

This class cannot be instantiated directly and also cannot be directly inherited by user-defined classes.

See also

AbstractMethodVariant

Since

Qore 0.9.0

Member Function Documentation

constructor()

Qore::Reflection::AbstractMethod::constructor

(

)

Throws an exception if called directly; this class can only be instantiated by builtin subclasses.

Exceptions

ABSTRACTMETHOD-CONSTRUCTOR-ERROR

this exception is thrown if this class is constructed directly (also if directly inherited by user classes)

getClass()

AbstractClass Qore::Reflection::AbstractMethod::getClass

(

)

Returns the class for the method.

Code Flags:

CONSTANT

Example:

AbstractClass cls = m.getClass();

Returns

the class for the method

getMethodTypeName()

string Qore::Reflection::AbstractMethod::getMethodTypeName

(

)

returns the type of method as a string; one of "normal", "static", "constructor", "destructor", "copy"

Code Flags:

RET_VALUE_ONLY

Example:

string type = m.getMethodTypeName();

Returns

the type of method as a string; one of "normal", "static", "constructor", "destructor", "copy"

Exceptions

PROGRAM-ERROR

thrown if the Program object holding the class and method has been destroyed

getVariant()

AbstractMethodVariant Qore::Reflection::AbstractMethod::getVariant

(

...

)

Returns the given direct child method variant declared in this method or throws an exception if the method variant is not defined.

Code Flags:

RET_VALUE_ONLY

Example:

AbstractMethodVariant v = n.getVariant(IntType, StringType);

Parameters

...	type arguments for the variant; types must be compatible for the search to be successful

Returns

given method variant or throws an exception if the method variant is not defined in this method

Exceptions

PROGRAM-ERROR	thrown if the Program object holding the class and the method has been destroyed
VARIANT-MATCH-ERROR	thrown if the variant cannot be matched to the given arguments
ENCODING-CONVERSION-ERROR	this exception could be thrown if the string argument is not in the default character encoding and an error occurs during encoding conversion

See also

• getVariantArgs()
• getExactVariant()
• getExactVariantArgs()

getVariantArgs()

AbstractMethodVariant Qore::Reflection::AbstractMethod::getVariantArgs

(

softlist< Type >

argv

)

Returns the given direct child method variant declared in this method or throws an exception if the method variant is not defined.

Code Flags:

RET_VALUE_ONLY

Example:

AbstractMethodVariant v = n.getVariantArgs((IntType, StringType));

Parameters

argv	type arguments for the variant; types must be compatible for the search to be successful

Returns

given method variant or throws an exception if the method variant is not defined in this method

Exceptions

PROGRAM-ERROR	thrown if the Program object holding the class and the method has been destroyed
VARIANT-MATCH-ERROR	thrown if the variant cannot be matched to the given arguments
ENCODING-CONVERSION-ERROR	this exception could be thrown if the string argument is not in the default character encoding and an error occurs during encoding conversion

See also

• getVariant()
• getExactVariant()
• getExactVariantArgs()

getVariants()

list< AbstractMethodVariant > Qore::Reflection::AbstractMethod::getVariants

(

)

returns the variants implemented by the method

Code Flags:

RET_VALUE_ONLY

Example:

list<AbstractMethodVariant> l = f.getVariants();

Returns

the variants implemented by the method

Exceptions

PROGRAM-ERROR

thrown if the Program object holding the class and the method has been destroyed

isStatic()

bool Qore::Reflection::AbstractMethod::isStatic

(

)

returns True if the method is a static method

Code Flags:

RET_VALUE_ONLY

Example:

bool b = m.isStatic();

Returns

True if the method is a static method

Exceptions

PROGRAM-ERROR

thrown if the Program object holding the class and method has been destroyed

---

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

• QC_AbstractMethod.dox.h