Compares strings using different comparison modes. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

#include <string_comparer.h>

Inherits System::Object, System::Collections::Generic::IComparer< String >, and System::Collections::Generic::IEqualityComparer< String >.

Public Types
typedef const String &	args_type
	Argument type. More...

Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	Alias for smart pointer type. More...

Public Types inherited from System::Collections::Generic::IComparer< String >
typedef const String &	args_type
	Comparison argument type. More...

Public Member Functions
virtual int	Compare (args_type x, args_type y) const override
	Compares two strings using current settings. More...

virtual bool	Equals (String x, String y) const override
	Checks if two strings are equal using current settings. More...

virtual int	GetHashCode (String obj) const override
	Gets string's hash code. More...

Public Member Functions inherited from System::Object
	Object ()
	Creates object. Initializes all internal data structures. More...

virtual	~Object ()
	Destroys object. Frees all internal data structures. More...

	Object (Object const &x)
	Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object *	SharedRefAdded ()
	Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

int	SharedRefRemovedSafe ()
	Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

int	RemovedSharedRefs (int count)
	Decreases shared reference count by specified value. More...

Detail::SmartPtrCounter *	WeakRefAdded ()
	Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

void	WeakRefRemoved ()
	Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

Detail::SmartPtrCounter *	GetCounter ()
	Gets reference counter data structure associated with the object. More...

int	SharedCount () const
	Gets current value of shared reference counter. More...

void	Lock ()
	Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...

void	Unlock ()
	Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...

virtual bool	Equals (ptr obj)
	Compares objects using C# Object.Equals semantics. More...

virtual int32_t	GetHashCode () const
	Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...

virtual String	ToString () const
	Analog of C# Object.ToString() method. Enables converting custom objects to string. More...

virtual ptr	MemberwiseClone () const
	Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...

virtual const TypeInfo &	GetType () const
	Gets actual type of object. Analog of C# System.Object.GetType() call. More...

virtual bool	Is (const TypeInfo &targetType) const
	Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...

virtual void	SetTemplateWeakPtr (uint32_t argument)
	Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...

virtual bool	FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
	For internal purposes only. More...

template<>
bool	ReferenceEquals (String const &str, std::nullptr_t)
	Specialization of Object::ReferenceEquals for case of string and nullptr. More...

template<>
bool	ReferenceEquals (String const &str1, String const &str2)
	Specialization of Object::ReferenceEquals for case of strings. More...

virtual int	Compare (args_type x, args_type y) const=0
	Comparison function. More...

Public Member Functions inherited from System::Collections::Generic::IEqualityComparer< String >
	RTTI_INFO_TEMPLATE_CLASS (System::Collections::Generic::IEqualityComparer< String >, System::BaseTypesInfo< System::Object >)
	RTTI information. More...

virtual bool	Equals (String x, String y) const=0
	Checks if two objects are equal. More...

virtual int	GetHashCode (String obj) const=0
	Gets hash code for some object. More...

Static Public Member Functions
static StringComparerPtr	get_Ordinal ()
	Ordinal comparer singleton. More...

static StringComparerPtr	get_OrdinalIgnoreCase ()
	Ordinal case-ignoring comparer singleton. More...

static StringComparerPtr	get_InvariantCulture ()
	Invariant culture comparer singleton. More...

static StringComparerPtr	get_InvariantCultureIgnoreCase ()
	Invariant culture case-ignoring comparer singleton. More...

static StringComparerPtr	get_CurrentCulture ()
	Current culture comparer singleton. More...

static StringComparerPtr	get_CurrentCultureIgnoreCase ()
	Current culture case-ignoring comparer singleton. More...

static StringComparerPtr	Create (const System::SharedPtr< System::Globalization::CultureInfo > &culture, bool ignoreCase)
	Creates culture-specific comparer. More...

Static Public Member Functions inherited from System::Object
static bool	ReferenceEquals (ptr const &objA, ptr const &objB)
	Compares objects by reference. More...

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, T const &objB)
	Compares objects by reference. More...

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, std::nullptr_t)
	Reference-compares value type object with nullptr. More...

template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares reference type objects in C# style. More...

template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares value type objects in C# style. More...

static const TypeInfo &	Type ()
	Implements C# typeof(System.Object) construct. More...

template<>
bool	Equals (float const &objA, float const &objB)
	Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...

template<>
bool	Equals (double const &objA, double const &objB)
	Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...

Detailed Description

Compares strings using different comparison modes. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

Member Typedef Documentation

◆ args_type

typedef const String& System::StringComparer::args_type

Argument type.

Member Function Documentation

◆ Compare()

virtual int System::StringComparer::Compare	(	args_type	x,
		args_type	y
	)		const

overridevirtual

Compares two strings using current settings.

Parameters

x	LHS string value.
y	RHS string value.

Returns: Negative value if x preceeds y, zero if they are equal and positive value otherwise.

Implements System::Collections::Generic::IComparer< String >.

◆ Create()

static StringComparerPtr System::StringComparer::Create	(	const System::SharedPtr< System::Globalization::CultureInfo > &	culture,
		bool	ignoreCase
	)

static

Creates culture-specific comparer.

Parameters

culture	Culture to create comparer for.
ignoreCase	Whether the comparer should ignore case.

Returns: Pointer to newly created comparer object.

◆ Equals()

virtual bool System::StringComparer::Equals	(	String	x,
		String	y
	)		const

overridevirtual

Checks if two strings are equal using current settings.

Parameters

x	LHS string value.
y	RHS string value.

Returns: True if strings are equal, false otherwise.

Implements System::Collections::Generic::IEqualityComparer< String >.

◆ get_CurrentCulture()

static StringComparerPtr System::StringComparer::get_CurrentCulture ( )

static

Current culture comparer singleton.

Returns: Pointer to current culture comparer.

◆ get_CurrentCultureIgnoreCase()

static StringComparerPtr System::StringComparer::get_CurrentCultureIgnoreCase ( )

static

Current culture case-ignoring comparer singleton.

Returns: Pointer to current culture case-ignoring comparer.

◆ get_InvariantCulture()

static StringComparerPtr System::StringComparer::get_InvariantCulture ( )

static

Invariant culture comparer singleton.

Returns: Pointer to invariant culture comparer.

◆ get_InvariantCultureIgnoreCase()

static StringComparerPtr System::StringComparer::get_InvariantCultureIgnoreCase ( )

static

Invariant culture case-ignoring comparer singleton.

Returns: Pointer to invariant culture case-ignoring comparer.

◆ get_Ordinal()

static StringComparerPtr System::StringComparer::get_Ordinal ( )

static

Ordinal comparer singleton.

Returns: Pointer to ordinal comparer.

◆ get_OrdinalIgnoreCase()

static StringComparerPtr System::StringComparer::get_OrdinalIgnoreCase ( )

static

Ordinal case-ignoring comparer singleton.

Returns: Pointer to ordinal case-ignoring comparer.

◆ GetHashCode()

virtual int System::StringComparer::GetHashCode ( String obj ) const

overridevirtual

Gets string's hash code.

Parameters

obj	String to calculate hash code for.

Returns: Hash code calculated for obj.

Implements System::Collections::Generic::IEqualityComparer< String >.

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ args_type

Member Function Documentation

◆ Compare()

◆ Create()

◆ Equals()

◆ get_CurrentCulture()

◆ get_CurrentCultureIgnoreCase()

◆ get_InvariantCulture()

◆ get_InvariantCultureIgnoreCase()

◆ get_Ordinal()

◆ get_OrdinalIgnoreCase()

◆ GetHashCode()