xtd::box_integer< type_t > Class Template Reference

Definition

template<typename type_t>
class xtd::box_integer< type_t >

Represents a boxed integer object.

class box_integer : public xtd::box<type_t>

Inheritance

xtd::object → xtd::box <type_t> → xtd::box_integer <type_t> ///

Namespace

Header

#include <xtd/box_integer> 

Namespace

xtd

Library

xtd.core

Remarks

You can use xtd::box to represent a class or structure that does not inherit from xtd::object. Typically used for integral types.

Use xtd::boxing to box an object.

Use xtd::unboxing to unbox an object.

For more information about types, see Native types, boxing and unboxing.

Examples

The following example shows how to create and use xtd::box_integer<int32>.

auto stringer = [](const object& value) {return value.to_string();};
int32 unboxed_object = 42;
box_integer<int32> boxed_object = unboxed_object;
auto result = stringer(boxed_object);
console::write_line("result = {}", result); // Display: result = 42;

Static Public Attributes
static constexpr type_t	max_value = std::numeric_limits<type_t>::max()
	Represents the largest possible value of type_t. This field is constant. More...
static constexpr type_t	min_value = std::numeric_limits<type_t>::lowest()
	Represents the smallest possible value of type_t. This field is constant. More...

Additional Inherited Members
Public Types inherited from xtd::box< type_t >
using	underlying_type = type_t
Public Member Functions inherited from xtd::box< type_t >
	box ()=default
	Initialize a new xtd::box object. More...
	box (const type_t &value)
	Initialize a new xtd::box object with specified value. More...
template<typename ... args_t>
	box (args_t &&...args)
	Initialize a new xtd::box object with specified value. More...
const type_t &	value () const noexcept
	Gets the underlying value. More...
type_t &	value () noexcept
	Gets the underlying value. More...
box &	value (const type_t &value)
	Sets de underlying value. More...
	operator type_t () const noexcept
bool	equals (const box &value) const noexcept override
	Indicates whether the current object is equal to another object of the same type. More...
int32	compare_to (const box &value) const noexcept override
	Compares the current instance with another object of the same type. More...
xtd::ustring	to_string () const noexcept override
	Returns a sxd::ustring that represents the current object. More...
xtd::ustring	to_string (const xtd::ustring &format) const noexcept
	Converts the value of this instance to its equivalent string representation, using the specified format. More...
Public Member Functions inherited from xtd::icomparable< box< type_t > >
Public Member Functions inherited from xtd::iequatable< box< type_t > >
Public Member Functions inherited from xtd::object
	object ()=default
	Create a new instance of the ultimate base class object. More...
bool	equals (const object &obj) const noexcept
	Determines whether the specified object is equal to the current object. More...
virtual size_t	get_hash_code () const noexcept
	Serves as a hash function for a particular type. More...
virtual type_object	get_type () const noexcept
	Gets the type of the current instance. More...
template<typename object_t >
std::unique_ptr< object_t >	memberwise_clone () const noexcept
	Creates a shallow copy of the current object. More...
Static Public Member Functions inherited from xtd::box< type_t >
static type_t	parse (const xtd::ustring &value)
	Converts the string to its type_t equivalent. More...
static bool	try_parse (const xtd::ustring &value, type_t &result) noexcept
	Converts the string to its type_t equivalent. A return value indicates whether the conversion succeeded or failed. More...
Static Public Member Functions inherited from xtd::object
static bool	equals (const object &object_a, const object &object_b) noexcept
	Determines whether the specified object instances are considered equal. More...
static bool	reference_equals (const object &object_a, const object &object_b) noexcept
	Determines whether the specified object instances are the same instance. More...

Member Data Documentation

max_value

template<typename type_t>

constexpr type_t xtd::box_integer< type_t >::max_value = std::numeric_limits<type_t>::max()

static

Represents the largest possible value of type_t. This field is constant.

Remarks

The value of this field is std::numeric_limits<type_t>::max().

Examples:

date_time_max_value.cpp.

min_value

template<typename type_t>

constexpr type_t xtd::box_integer< type_t >::min_value = std::numeric_limits<type_t>::lowest()

static

Represents the smallest possible value of type_t. This field is constant.

Remarks

The value of this field is std::numeric_limits<type_t>::lowest().

Examples:

console_read.cpp.

---

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

• xtd.core/include/xtd/box_integer.h