generic-library/poco
1
0
Fork 0
mirror of https://github.com/pocoproject/poco.git synced 2025-01-19 08:46:41 +01:00
Code Issues Projects Releases Wiki Activity

documentation fix

Browse Source
This commit is contained in:
Aleksandar Fabijanic 2012-09-12 03:20:24 +00:00
parent b99dd6ddb0
commit 62d1782d24
1 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
Foundation/include/Poco/Nullable.h
View File

@ -52,12 +52,13 @@ namespace Poco {
template <typename C> template <typename C>
class Nullable class Nullable
/// Nullable is a simple wrapper class for value types /// Nullable is a simple wrapper class for value types
/// that allows to introduce a "null" value or state /// that allows objects or native type variables
/// to value objects. /// to have "null" value.
/// ///
/// The class is useful for passing parameters to functions /// The class is useful for passing parameters to functions
/// when parameters are optional and no default values /// when parameters are optional and no default values
/// should be used. /// should be used or when a non-assigned state is needed,
/// such as in e.g. fetching null values from database.
/// ///
/// A Nullable can be default constructed. In this case, /// A Nullable can be default constructed. In this case,
/// the Nullable will have a Null value and isNull() will /// the Nullable will have a Null value and isNull() will
@ -116,16 +117,19 @@ public:
} }
Nullable& operator = (const C& value) Nullable& operator = (const C& value)
/// Assigns a value to the Nullable.
{ {
return assign(value); return assign(value);
} }
Nullable& operator = (const Nullable& other) Nullable& operator = (const Nullable& other)
/// Assigns another Nullable.
{ {
return assign(other); return assign(other);
} }
void swap(Nullable& other) void swap(Nullable& other)
/// Swaps this Nullable with other.
{ {
std::swap(_value, other._value); std::swap(_value, other._value);
std::swap(_isNull, other._isNull); std::swap(_isNull, other._isNull);
@ -158,7 +162,7 @@ public:
bool operator < (const Nullable<C>& other) const bool operator < (const Nullable<C>& other) const
/// Compares two Nullable objects. Return true if this object's /// Compares two Nullable objects. Return true if this object's
/// value is smaler than the other object's value. /// value is smaler than the other object's value.
/// Null value is smaller than any non-null value. /// Null value is smaller than a non-null value.
{ {
if (_isNull && other._isNull) return false; if (_isNull && other._isNull) return false;
@ -173,7 +177,7 @@ public:
bool operator > (const Nullable<C>& other) const bool operator > (const Nullable<C>& other) const
/// Compares two Nullable objects. Return true if this object's /// Compares two Nullable objects. Return true if this object's
/// value is greater than the other object's value. /// value is greater than the other object's value.
/// Any non-null value is greater than a null value. /// A non-null value is greater than a null value.
{ {
return !(*this == other) && !(*this < other); return !(*this == other) && !(*this < other);
} }
@ -221,7 +225,7 @@ public:
} }
private: private:
C _value; C _value;
bool _isNull; bool _isNull;
}; };
@ -240,6 +244,7 @@ std::ostream& operator<<(std::ostream& out, const Nullable<C>& obj)
return out; return out;
} }
} // namespace Poco } // namespace Poco