Definition

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

Represents a boxed char object.

class box_char : public xtd::box_integer<type_t>

Inheritance: xtd::object → xtd::box <type_t> → xtd::box_integer <type_t> → xtd::box_char <type_t>

Header: #include <xtd/box_char>

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_char<char8>.
auto stringer = [](const object& value) {return value.to_string();};
char8 unboxed_object = u8'a';
box_char<char8> boxed_object = unboxed_object;
auto result = stringer(boxed_object);
console::write_line("result = {}", result); // Display: result = a;

Static Public Member Functions
static bool	is_ascii (type_t c) noexcept
	Returns true if c is an ASCII character ([ U+0000..U+007F ]). More...

static bool	is_ascii (const ustring &s, size_t index)
	Indicates whether the character at the specified position in a specified string is an ASCII character ([ U+0000..U+007F ]). More...

static bool	is_control (type_t c) noexcept
	Indicates whether the specified Unicode character is categorized as a control character. More...

static bool	is_control (const ustring &s, size_t index)
	Indicates whether the character at the specified position in a specified string is categorized as a control character. More...

static bool	is_digit (type_t c) noexcept
	Indicates whether the specified Unicode character is categorized as a decimal digit. More...

static bool	is_digit (const ustring &s, size_t index)
	Indicates whether the character at the specified position in a specified string is categorized as a decimal digit. More...

static bool	is_letter (type_t c) noexcept
	Indicates whether the specified Unicode character is categorized as a Unicode letter. More...

static bool	is_letter (const ustring &s, size_t index)
	Indicates whether the character at the specified position in a specified string is categorized as a Unicode letter. More...

static bool	is_letter_or_digit (type_t c) noexcept
	Indicates whether a Unicode character is categorized as a letter or a decimal digit. More...

static bool	is_letter_or_digit (const ustring &s, size_t index)
	Indicates whether the character at the specified position in a specified string is categorized as a letter or a decimal digit. More...

static bool	is_lower (type_t c) noexcept
	ndicates whether the specified Unicode character is categorized as a lowercase letter. More...

static bool	is_lower (const ustring &s, size_t index)
	Indicates whether the character at the specified position in a specified string is categorized as a lowercase letter. More...

static bool	is_number (type_t c) noexcept
	Indicates whether a Unicode character is categorized as a number. More...

static bool	is_number (const ustring &s, size_t index)
	Indicates whether the character at the specified position in a specified string is categorized as a number. More...

static bool	is_punctuation (type_t c) noexcept
	Indicates whether the specified Unicode character is categorized as a punctuation mark. More...

static bool	is_punctuation (const ustring &s, size_t index)
	Indicates whether the character at the specified position in a specified string is categorized as a punctuation mark. More...

static bool	is_separator (type_t c) noexcept
	Indicates whether the specified Unicode character is categorized as a separator character. More...

static bool	is_separator (const ustring &s, size_t index)
	Indicates whether the character at the specified position in a specified string is categorized as a separator character. More...

static bool	is_symbol (type_t c) noexcept
	Indicates whether the specified Unicode character is categorized as a symbol character. More...

static bool	is_symbol (const ustring &s, size_t index)
	Indicates whether the character at the specified position in a specified string is categorized as a symbol character. More...

static bool	is_upper (type_t c) noexcept
	Indicates whether the specified Unicode character is categorized as an uppercase letter. More...

static bool	is_upper (const ustring &s, size_t index)
	Indicates whether the character at the specified position in a specified string is categorized as an uppercase letter. More...

static bool	is_white_space (type_t c) noexcept
	Indicates whether the specified Unicode character is categorized as white space. More...

static bool	is_white_space (const ustring &s, size_t index)
	Indicates whether the character at the specified position in a specified string is categorized as white space. More...

static char	to_lower (type_t c) noexcept
	Converts the value of a Unicode character to its lowercase equivalent. More...

static char	to_upper (type_t c) noexcept
	Converts the value of a Unicode character to its uppercase equivalent. 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...

Additional Inherited Members
Public Types inherited from xtd::box< type_t >
using	underlying_type = type_t

Static Public Attributes inherited from xtd::box_integer< type_t >
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...

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

Member Function Documentation

◆ is_ascii() [1/2]

template<typename type_t>

static bool xtd::box_char< type_t >::is_ascii ( type_t c )

inlinestaticnoexcept

Returns true if c is an ASCII character ([ U+0000..U+007F ]).

Parameters

c	The character to analyze.

Returns: true if c is an ASCII character; false otherwise.

◆ is_ascii() [2/2]

template<typename type_t>

static bool xtd::box_char< type_t >::is_ascii	(	const ustring &	s,
		size_t	index
	)

inlinestatic

Indicates whether the character at the specified position in a specified string is an ASCII character ([ U+0000..U+007F ]).

Parameters

s	A string.
index	The position of the character to evaluate in s.

Returns: true if the character at position index in s is n ASCII character; otherwise, false.

Exceptions

xtd::argument_out_of_range_exception index is greater than the last position in s.

◆ is_control() [1/2]

template<typename type_t>

static bool xtd::box_char< type_t >::is_control ( type_t c )

inlinestaticnoexcept

Indicates whether the specified Unicode character is categorized as a control character.

Parameters

c	The Unicode character to evaluate.

Returns: true if c is a control character; otherwise, false.

◆ is_control() [2/2]

template<typename type_t>

static bool xtd::box_char< type_t >::is_control	(	const ustring &	s,
		size_t	index
	)

inlinestatic

Indicates whether the character at the specified position in a specified string is categorized as a control character.

Parameters

s	A string.
index	The position of the character to evaluate in s.

Returns: true if the character at position index in s is a control character; otherwise, false.

Exceptions

xtd::argument_out_of_range_exception index is greater than the last position in s.

◆ is_digit() [1/2]

template<typename type_t>

static bool xtd::box_char< type_t >::is_digit ( type_t c )

inlinestaticnoexcept

Indicates whether the specified Unicode character is categorized as a decimal digit.

Parameters

c	The Unicode character to evaluate.

Returns: true if c is a decimal digit; otherwise, false.

Remarks: This method determines whether a type_tis a radix-10 digit. This contrasts with is_number, which determines whether a Char is of any numeric Unicode category. Numbers include characters such as fractions, subscripts, superscripts, Roman numerals, currency numerators, encircled numbers, and script-specific digits.

◆ is_digit() [2/2]

template<typename type_t>

static bool xtd::box_char< type_t >::is_digit	(	const ustring &	s,
		size_t	index
	)

inlinestatic

Indicates whether the character at the specified position in a specified string is categorized as a decimal digit.

Parameters

s	A string.
index	The position of the character to evaluate in s.

Returns: true if the character at position index in s is decimal digit; otherwise, false.

Exceptions

xtd::argument_out_of_range_exception index is greater than the last position in s.

◆ is_letter() [1/2]

template<typename type_t>

static bool xtd::box_char< type_t >::is_letter ( type_t c )

inlinestaticnoexcept

Indicates whether the specified Unicode character is categorized as a Unicode letter.

Parameters

c	The Unicode character to evaluate.

Returns: true if c is a letter; otherwise, false.

◆ is_letter() [2/2]

template<typename type_t>

static bool xtd::box_char< type_t >::is_letter	(	const ustring &	s,
		size_t	index
	)

inlinestatic

Indicates whether the character at the specified position in a specified string is categorized as a Unicode letter.

Parameters

s	A string.
index	The position of the character to evaluate in s.

Returns: true if the character at position index in s is a letter; otherwise, false.

Exceptions

xtd::argument_out_of_range_exception index is greater than the last position in s.

◆ is_letter_or_digit() [1/2]

template<typename type_t>

static bool xtd::box_char< type_t >::is_letter_or_digit ( type_t c )

inlinestaticnoexcept

Indicates whether a Unicode character is categorized as a letter or a decimal digit.

Parameters

c	The Unicode character to evaluate.

Returns: true if c is a letter or a decimal digit; otherwise, false.

◆ is_letter_or_digit() [2/2]

template<typename type_t>

static bool xtd::box_char< type_t >::is_letter_or_digit	(	const ustring &	s,
		size_t	index
	)

inlinestatic

Indicates whether the character at the specified position in a specified string is categorized as a letter or a decimal digit.

Parameters

s	A string.
index	The position of the character to evaluate in s.

Returns: true if the character at position index in s is a letter or a decimal digit; otherwise, false.

Exceptions

xtd::argument_out_of_range_exception index is greater than the last position in s.

◆ is_lower() [1/2]

template<typename type_t>

static bool xtd::box_char< type_t >::is_lower ( type_t c )

inlinestaticnoexcept

ndicates whether the specified Unicode character is categorized as a lowercase letter.

Parameters

c	The Unicode character to evaluate.

Returns: true if c is a lowercase letter; otherwise, false.

◆ is_lower() [2/2]

template<typename type_t>

static bool xtd::box_char< type_t >::is_lower	(	const ustring &	s,
		size_t	index
	)

inlinestatic

Indicates whether the character at the specified position in a specified string is categorized as a lowercase letter.

Parameters

s	A string.
index	The position of the character to evaluate in s.

Returns: true if the character at position index in s is a lowercase letter; otherwise, false.

Exceptions

xtd::argument_out_of_range_exception index is greater than the last position in s.

◆ is_number() [1/2]

template<typename type_t>

static bool xtd::box_char< type_t >::is_number ( type_t c )

inlinestaticnoexcept

Indicates whether a Unicode character is categorized as a number.

Parameters

c	The Unicode character to evaluate.

Returns: true if c is a number; otherwise, false.

◆ is_number() [2/2]

template<typename type_t>

static bool xtd::box_char< type_t >::is_number	(	const ustring &	s,
		size_t	index
	)

inlinestatic

Indicates whether the character at the specified position in a specified string is categorized as a number.

Parameters

s	A string.
index	The position of the character to evaluate in s.

Returns: true if the character at position index in s is a number; otherwise, false.

Exceptions

xtd::argument_out_of_range_exception index is greater than the last position in s.

◆ is_punctuation() [1/2]

template<typename type_t>

static bool xtd::box_char< type_t >::is_punctuation ( type_t c )

inlinestaticnoexcept

Indicates whether the specified Unicode character is categorized as a punctuation mark.

Parameters

c	The Unicode character to evaluate.

Returns: true if c is a punctuation mark; otherwise, false.

◆ is_punctuation() [2/2]

template<typename type_t>

static bool xtd::box_char< type_t >::is_punctuation	(	const ustring &	s,
		size_t	index
	)

inlinestatic

Indicates whether the character at the specified position in a specified string is categorized as a punctuation mark.

Parameters

s	A string.
index	The position of the character to evaluate in s.

Returns: true if the character at position index in s is categorized as a punctuation mark.

Exceptions

xtd::argument_out_of_range_exception index is greater than the last position in s.

◆ is_separator() [1/2]

template<typename type_t>

static bool xtd::box_char< type_t >::is_separator ( type_t c )

inlinestaticnoexcept

Indicates whether the specified Unicode character is categorized as a separator character.

Parameters

c	The Unicode character to evaluate.

Returns: true if c is a separator character; otherwise, false.

◆ is_separator() [2/2]

template<typename type_t>

static bool xtd::box_char< type_t >::is_separator	(	const ustring &	s,
		size_t	index
	)

inlinestatic

Indicates whether the character at the specified position in a specified string is categorized as a separator character.

Parameters

s	A string.
index	The position of the character to evaluate in s.

Returns: true if the character at position index in s is categorized as a separator character.

Exceptions

xtd::argument_out_of_range_exception index is greater than the last position in s.

◆ is_symbol() [1/2]

template<typename type_t>

static bool xtd::box_char< type_t >::is_symbol ( type_t c )

inlinestaticnoexcept

Indicates whether the specified Unicode character is categorized as a symbol character.

Parameters

c	The Unicode character to evaluate.

Returns: true if c is a symbol character; otherwise, false.

◆ is_symbol() [2/2]

template<typename type_t>

static bool xtd::box_char< type_t >::is_symbol	(	const ustring &	s,
		size_t	index
	)

inlinestatic

Indicates whether the character at the specified position in a specified string is categorized as a symbol character.

Parameters

s	A string.
index	The position of the character to evaluate in s.

Returns: true if the character at position index in s is a symbol character; otherwise, false.

Exceptions

xtd::argument_out_of_range_exception index is greater than the last position in s.

◆ is_upper() [1/2]

template<typename type_t>

static bool xtd::box_char< type_t >::is_upper ( type_t c )

inlinestaticnoexcept

Indicates whether the specified Unicode character is categorized as an uppercase letter.

Parameters

c	The Unicode character to evaluate.

Returns: true if c is an uppercase letter; otherwise, false.

◆ is_upper() [2/2]

template<typename type_t>

static bool xtd::box_char< type_t >::is_upper	(	const ustring &	s,
		size_t	index
	)

inlinestatic

Indicates whether the character at the specified position in a specified string is categorized as an uppercase letter.

Parameters

s	A string.
index	The position of the character to evaluate in s.

Returns: true if the character at position index in s is an uppercase letter; otherwise, false.

Exceptions

xtd::argument_out_of_range_exception index is greater than the last position in s.

◆ is_white_space() [1/2]

template<typename type_t>

static bool xtd::box_char< type_t >::is_white_space ( type_t c )

inlinestaticnoexcept

Indicates whether the specified Unicode character is categorized as white space.

Parameters

c	The Unicode character to evaluate.

Returns: true if c is white space; otherwise, false.

Examples:: console_read.cpp.

◆ is_white_space() [2/2]

template<typename type_t>

static bool xtd::box_char< type_t >::is_white_space	(	const ustring &	s,
		size_t	index
	)

inlinestatic

Indicates whether the character at the specified position in a specified string is categorized as white space.

Parameters

s	A string.
index	The position of the character to evaluate in s.

Returns: true if the character at position index in s is white space; otherwise, false.

Exceptions

xtd::argument_out_of_range_exception index is greater than the last position in s.

◆ to_lower()

template<typename type_t>

static char xtd::box_char< type_t >::to_lower ( type_t c )

inlinestaticnoexcept

Converts the value of a Unicode character to its lowercase equivalent.

Parameters

c	The Unicode character to convert.

Returns: The lowercase equivalent of c, or the unchanged value of c, if c is already lowercase or not alphabetic.

◆ to_upper()

template<typename type_t>

static char xtd::box_char< type_t >::to_upper ( type_t c )

inlinestaticnoexcept

Converts the value of a Unicode character to its uppercase equivalent.

Parameters

c	The Unicode character to convert.

Returns: The uppercase equivalent of c, or the unchanged value of c if c is already uppercase, has no uppercase equivalent, or is not alphabetic.

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

xtd.core/include/xtd/box_char.h

Definition

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

Static Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ is_ascii() [1/2]

◆ is_ascii() [2/2]

◆ is_control() [1/2]

◆ is_control() [2/2]

◆ is_digit() [1/2]

◆ is_digit() [2/2]

◆ is_letter() [1/2]

◆ is_letter() [2/2]

◆ is_letter_or_digit() [1/2]

◆ is_letter_or_digit() [2/2]

◆ is_lower() [1/2]

◆ is_lower() [2/2]

◆ is_number() [1/2]

◆ is_number() [2/2]

◆ is_punctuation() [1/2]

◆ is_punctuation() [2/2]

◆ is_separator() [1/2]

◆ is_separator() [2/2]

◆ is_symbol() [1/2]

◆ is_symbol() [2/2]

◆ is_upper() [1/2]

◆ is_upper() [2/2]

◆ is_white_space() [1/2]

◆ is_white_space() [2/2]

◆ to_lower()

◆ to_upper()

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