xtd 0.2.0
Loading...
Searching...
No Matches
xtd::box_integer< type_t > Class Template Reference
Inheritance diagram for xtd::box_integer< type_t >:
xtd::box< type_t > xtd::icomparable< box< type_t > > xtd::iequatable< box< type_t > > xtd::object xtd::interface xtd::interface xtd::box_char< type_t > xtd::box_floating_point< type_t >

Definition

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

Represents a boxed integer object.

class box_integer : public xtd::box<type_t>
Represents a boxed integer object.
Definition box_integer.h:50
Represents a boxed object.
Definition box.h:47
Inheritance
xtd::objectxtd::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;
const type_t & value() const noexcept
Gets the underlying value.
Definition box.h:79
static void write_line()
Writes the current line terminator to the standard output stream using the specified format informati...
int_least32_t int32
Represents a 32-bit signed integer.
Definition types.h:131
Examples
console_out.cpp.

Public Fields

static constexpr type_t max_value
 Represents the largest possible value of type_t. This field is constant.
 
static constexpr type_t min_value
 Represents the smallest possible value of type_t. This field is constant.
 

Public Static Methods

static type_t parse (const xtd::ustring &value, xtd::number_styles styles)
 Converts the string to its type_t equivalent.
 
static bool parse (const xtd::ustring &value, type_t &result, xtd::number_styles styles)
 Converts the string to its type_t equivalent.
 

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.
 
 box (const type_t &value)
 Initialize a new xtd::box object with specified value.
 
template<typename ... args_t>
 box (args_t &&...args)
 Initialize a new xtd::box object with specified value.
 
const type_t & value () const noexcept
 Gets the underlying value.
 
type_t & value () noexcept
 Gets the underlying value.
 
boxvalue (const type_t &value)
 Sets de underlying value.
 
 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.
 
int32 compare_to (const box &value) const noexcept override
 Compares the current instance with another object of the same type.
 
xtd::ustring to_string () const noexcept override
 Returns a sxd::ustring that represents the current object.
 
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.
 
- 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.
 
bool equals (const object &obj) const noexcept
 Determines whether the specified object is equal to the current object.
 
virtual size_t get_hash_code () const noexcept
 Serves as a hash function for a particular type.
 
virtual type_object get_type () const noexcept
 Gets the type of the current instance.
 
template<typename object_t >
std::unique_ptr< object_t > memberwise_clone () const noexcept
 Creates a shallow copy of the current object.
 
- 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.
 
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.
 
- 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.
 
static bool reference_equals (const object &object_a, const object &object_b) noexcept
 Determines whether the specified object instances are the same instance.
 

Member Function Documentation

◆ parse() [1/2]

template<typename type_t >
static bool xtd::box_integer< type_t >::parse ( const xtd::ustring value,
type_t &  result,
xtd::number_styles  styles 
)
inlinestatic

Converts the string to its type_t equivalent.

Parameters
valueA string containing a type_t to convert.
Returns
A type_t equivalent to the number contained in value.

◆ parse() [2/2]

template<typename type_t >
static type_t xtd::box_integer< type_t >::parse ( const xtd::ustring value,
xtd::number_styles  styles 
)
inlinestatic

Converts the string to its type_t equivalent.

Parameters
valueA string containing a type_t to convert.
Returns
A type_t equivalent to the number contained in value.

Member Data Documentation

◆ max_value

template<typename type_t >
constexpr type_t xtd::box_integer< type_t >::max_value
staticconstexpr

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().

◆ min_value

template<typename type_t >
constexpr type_t xtd::box_integer< type_t >::min_value
staticconstexpr

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().

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