RestLink::QueryParameter Class Reference

#include <queryparameter.h>

Inherits RestLink::Parameter.

Public Member Functions
	QueryParameter ()
	QueryParameter (const QString &name, const QVariant &value)
	QueryParameter (const QueryParameter &other)
	~QueryParameter ()
	Destructor for QueryParameter.
Parameter &	operator= (const Parameter &other)
	Copy assignment operator for Parameter class.
Parameter &	operator= (Parameter &&other)
	Move assignment operator for Parameter class.
bool	operator== (const Parameter &other) const
	Equality operator for Parameter class.
bool	operator!= (const Parameter &other) const
	Inequality operator for Parameter class.
Public Member Functions inherited from RestLink::Parameter
	Parameter ()
	Default constructor for Parameter class.
	Parameter (const Parameter &other)
	Copy constructor for Parameter class.
	Parameter (Parameter &&other)
	Move constructor for Parameter class.
	~Parameter ()
	Destructor for Parameter class.
Parameter &	operator= (const Parameter &other)
	Copy assignment operator for Parameter class.
Parameter &	operator= (Parameter &&other)
	Move assignment operator for Parameter class.
QString	name () const
	Retrieves the name of the parameter.
void	setName (const QString &name)
	Sets the name of the parameter.
QVariant	value () const
	Retrieves the value of the parameter.
void	setValue (const QVariant &value)
	Sets the value of the parameter.
QVariant	specialValue (Api *api) const
	Returns a special value for the parameter, based on the provided API.
QVariantList	specialValues (Api *api) const
	Returns a list of special values for the parameter, based on the provided API.
bool	hasValue (const QVariant &value) const
	Checks if the parameter contains a specific value.
void	addValue (const QVariant &value)
	Adds a value to the parameter.
void	removeValue (const QVariant &value)
	Removes a value from the parameter.
QList< QVariant >	values () const
	Returns a list of all values associated with the parameter.
void	setValues (const QList< QVariant > &values)
	Sets a list of values for the parameter.
bool	hasFlag (Flag flag) const
	Checks if a specific flag is set for the parameter.
Flags	flags () const
	Retrieves all flags set for the parameter.
void	setFlag (Flag flag, bool on=true)
	Sets or clears a specific flag for the parameter.
void	setFlags (const Flags &flags)
	Sets multiple flags for the parameter.
Type	type () const
	Returns the type of the parameter.
bool	isValid () const
	Checks if the parameter is valid.
PathParameter	toPathParameter () const
QueryParameter	toQueryParameter () const
Header	toHeader () const
QJsonObject	toJsonObject () const
	Converts the parameter to a QJsonObject.
bool	operator== (const Parameter &other) const
	Equality operator for Parameter class.
bool	operator!= (const Parameter &other) const
	Inequality operator for Parameter class.

Static Public Member Functions
static QueryParameter	fromJsonObject (const QJsonObject &object)
Static Public Member Functions inherited from RestLink::Parameter
static Parameter	fromJsonObject (const QJsonObject &object, Type type)
	Loads parameter information from a JSON object.
static Parameter	merge (const Parameter &p1, const Parameter &p2)
	Merges two Parameter objects into a single parameter.

Protected Member Functions
	QueryParameter (const QSharedDataPointer< ParameterData > &d)
Protected Member Functions inherited from RestLink::Parameter
	Parameter (ParameterData *d)
	Parameter (const QSharedDataPointer< ParameterData > &data)

Additional Inherited Members
Public Types inherited from RestLink::Parameter
enum	Flag { NoFlag = 0x0 , Authentication = 0x1 , Secret = 0x2 , Locale = 0x64 }
	Defines flags used to specify special attributes for a parameter. More...
enum	Type { BaseType , PathParameterType , QueryParameterType , HeaderType }
	Defines the possible types of parameters. More...
Static Protected Member Functions inherited from RestLink::Parameter
static void	dataFromJsonObject (ParameterData *data, const QJsonObject &object)
Protected Attributes inherited from RestLink::Parameter
QSharedDataPointer< ParameterData >	d_ptr

Constructor & Destructor Documentation

QueryParameter() [1/4]

RestLink::QueryParameter::QueryParameter

(

)

QueryParameter() [2/4]

RestLink::QueryParameter::QueryParameter	(	const QString &	name,
		const QVariant &	value
	)

QueryParameter() [3/4]

RestLink::QueryParameter::QueryParameter

(

const QueryParameter &

other

)

~QueryParameter()

RestLink::QueryParameter::~QueryParameter

(

)

Destructor for QueryParameter.

Cleans up resources held by the QueryParameter object.

QueryParameter() [4/4]

RestLink::QueryParameter::QueryParameter ( const QSharedDataPointer< ParameterData > &  d )

protected

Member Function Documentation

fromJsonObject()

QueryParameter RestLink::QueryParameter::fromJsonObject ( const QJsonObject &  object )

static

operator=() [1/2]

Parameter & RestLink::Parameter::operator=

(

const Parameter &

other

)

Copy assignment operator for Parameter class.

Copies the contents of one Parameter instance to another.

Parameters

other

The parameter to copy from.

Returns

A reference to the current instance.

operator=() [2/2]

Parameter & RestLink::Parameter::operator=

(

Parameter &&

other

)

Move assignment operator for Parameter class.

Transfers ownership of the resources from the provided parameter to the current instance.

Parameters

other

The parameter to move from.

Returns

A reference to the current instance.

operator==()

bool RestLink::Parameter::operator==

(

const Parameter &

other

)

const

Equality operator for Parameter class.

Two parameters are considered equal if they have the same name, value, and flags.

Parameters

other

The parameter to compare with.

Returns

True if the parameters are equal, false otherwise.

operator!=()

bool RestLink::Parameter::operator!=

(

const Parameter &

other

)

const

Inequality operator for Parameter class.

Two parameters are considered unequal if they differ in name, value, or flags.

Parameters

other

The parameter to compare with.

Returns

True if the parameters are unequal, false otherwise.