Asposecpplib

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

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

Public Types

typedef String args_type
 Argument type. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. More...
 
- Public Types inherited from System::Collections::Generic::IComparer< String >
typedef String args_type
 Comparison argument type. More...
 

Public Member Functions

virtual ASPOSECPP_SHARED_API int Compare (args_type x, args_type y) ASPOSE_CONST override
 Compares two strings using current settings. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (String x, String y) ASPOSE_CONST override
 Checks if two strings are equal using current settings. More...
 
virtual ASPOSECPP_SHARED_API int GetHashCode (String obj) const override
 Gets string's hash code. More...
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 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 refernce counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () ASPOSE_CONST
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. 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...
 
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...
 
- 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...
 

Static Public Member Functions

static ASPOSECPP_SHARED_API StringComparerPtr get_Ordinal ()
 Ordinal comparer singleton. More...
 
static ASPOSECPP_SHARED_API StringComparerPtr get_OrdinalIgnoreCase ()
 Ordinal case-ignoring comparer singleton. More...
 
static ASPOSECPP_SHARED_API StringComparerPtr get_InvariantCulture ()
 Invariant culture comparer singleton. More...
 
static ASPOSECPP_SHARED_API StringComparerPtr get_InvariantCultureIgnoreCase ()
 Invariant culture case-ignoring comparer singleton. More...
 
static ASPOSECPP_SHARED_API StringComparerPtr get_CurrentCulture ()
 Current culture comparer singleton. More...
 
static ASPOSECPP_SHARED_API StringComparerPtr get_CurrentCultureIgnoreCase ()
 Current culture case-ignoring comparer singleton. More...
 
static ASPOSECPP_SHARED_API 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 TypeInfoType ()
 Impleemnts C# typeof(System.Object) construct. 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

Argument type.

Member Function Documentation

◆ Compare()

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

Compares two strings using current settings.

Parameters
xLHS string value.
yRHS 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 ASPOSECPP_SHARED_API StringComparerPtr System::StringComparer::Create ( const System::SharedPtr< System::Globalization::CultureInfo > &  culture,
bool  ignoreCase 
)
static

Creates culture-specific comparer.

Parameters
cultureCulture to create comparer for.
ignoreCaseWhether the comparer should ignore case.
Returns
Pointer to newly created comparer object.

◆ Equals()

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

Checks if two strings are equal using current settings.

Parameters
xLHS string value.
yRHS string value.
Returns
True if strings are equal, false otherwise.

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

◆ get_CurrentCulture()

static ASPOSECPP_SHARED_API StringComparerPtr System::StringComparer::get_CurrentCulture ( )
static

Current culture comparer singleton.

Returns
Pointer to current culture comparer.

◆ get_CurrentCultureIgnoreCase()

static ASPOSECPP_SHARED_API StringComparerPtr System::StringComparer::get_CurrentCultureIgnoreCase ( )
static

Current culture case-ignoring comparer singleton.

Returns
Pointer to current culture case-ignoring comparer.

◆ get_InvariantCulture()

static ASPOSECPP_SHARED_API StringComparerPtr System::StringComparer::get_InvariantCulture ( )
static

Invariant culture comparer singleton.

Returns
Pointer to invariant culture comparer.

◆ get_InvariantCultureIgnoreCase()

static ASPOSECPP_SHARED_API StringComparerPtr System::StringComparer::get_InvariantCultureIgnoreCase ( )
static

Invariant culture case-ignoring comparer singleton.

Returns
Pointer to invariant culture case-ignoring comparer.

◆ get_Ordinal()

static ASPOSECPP_SHARED_API StringComparerPtr System::StringComparer::get_Ordinal ( )
static

Ordinal comparer singleton.

Returns
Pointer to ordinal comparer.

◆ get_OrdinalIgnoreCase()

static ASPOSECPP_SHARED_API StringComparerPtr System::StringComparer::get_OrdinalIgnoreCase ( )
static

Ordinal case-ignoring comparer singleton.

Returns
Pointer to ordinal case-ignoring comparer.

◆ GetHashCode()

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

Gets string's hash code.

Parameters
objString to calculate hash code for.
Returns
Hash code calculated for obj.

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