Pip-Services-Commons-Dotnet
Public Member Functions | Properties | List of all members
PipServices3.Commons.Data.AnyValue Class Reference

Cross-language implementation of dynamic object what can hold value of any type. The stored value can be converted to different types using variety of accessor methods. More...

Inheritance diagram for PipServices3.Commons.Data.AnyValue:
PipServices3.Commons.Data.ICloneable

Public Member Functions

 AnyValue (object value=null)
 Creates a new instance of the object and assigns its value. More...
 
 AnyValue (AnyValue value)
 Creates a new instance of the object and assigns its value. More...
 
object GetAsObject ()
 Gets the value stored in this object without any conversions More...
 
void SetAsObject (object value)
 Sets a new value for this object More...
 
string GetAsNullableString ()
 Converts object value into a string or returns null if conversion is not possible. More...
 
string GetAsString ()
 Converts object value into a string or returns "" if conversion is not possible. More...
 
string GetAsStringWithDefault (string defaultValue)
 Converts object value into a string or returns default value if conversion is not possible. More...
 
bool GetAsNullableBoolean ()
 Converts object value into a boolean or returns null if conversion is not possible. More...
 
bool GetAsBoolean ()
 Converts object value into a boolean or returns false if conversion is not possible. More...
 
bool GetAsBooleanWithDefault (bool defaultValue)
 Converts object value into a boolean or returns default value if conversion is not possible. More...
 
int GetAsNullableInteger ()
 Converts object value into an integer or returns null if conversion is not possible. More...
 
int GetAsInteger ()
 onverts object value into an integer or returns 0 if conversion is not possible. More...
 
int GetAsIntegerWithDefault (int defaultValue)
 Converts object value into a integer or returns default value if conversion is not possible. More...
 
long GetAsNullableLong ()
 Converts object value into a long or returns null if conversion is not possible. More...
 
long GetAsLong ()
 Converts object value into a long or returns 0 if conversion is not possible. More...
 
long GetAsLongWithDefault (long defaultValue)
 Converts object value into a long or returns default value if conversion is not possible. More...
 
float GetAsNullableFloat ()
 Converts object value into a float or returns null if conversion is not possible. More...
 
float GetAsFloat ()
 Converts object value into a float or returns 0 if conversion is not possible. More...
 
float GetAsFloatWithDefault (float defaultValue)
 Converts object value into a float or returns default value if conversion is not possible. More...
 
double GetAsNullableDouble ()
 Converts object value into a double or returns null if conversion is not possible. More...
 
double GetAsDouble ()
 Converts object value into a double or returns 0 if conversion is not possible. More...
 
double GetAsDoubleWithDefault (double defaultValue)
 Converts object value into a double or returns default value if conversion is not possible. More...
 
DateTime GetAsNullableDateTime ()
 Converts object value into a Date or returns null if conversion is not possible. More...
 
DateTime GetAsDateTime ()
 Converts object value into a Date or returns current date if conversion is not possible. More...
 
DateTime GetAsDateTimeWithDefault (DateTime? defaultValue)
 Converts object value into a Date or returns default value if conversion is not possible. More...
 
TimeSpan GetAsNullableTimeSpan ()
 
TimeSpan GetAsTimeSpan ()
 
TimeSpan GetAsTimeSpanWithDefault (TimeSpan? defaultValue)
 
GetAsNullableEnum< T > ()
 
GetAsEnum< T > ()
 
GetAsEnumWithDefault< T > (T defaultValue)
 
GetAsNullableType< T > ()
 Converts object value into a value defined by specied typecode. If conversion is not possible it returns null. More...
 
GetAsType< T > ()
 Converts object value into a value defined by specied typecode. If conversion is not possible it returns default value for the specified type. More...
 
GetAsTypeWithDefault< T > (T defaultValue)
 Converts object value into a value defined by specied typecode. If conversion is not possible it returns default value. More...
 
AnyValueArray GetAsArray ()
 Converts object value into an AnyArray or returns empty AnyArray if conversion is not possible. More...
 
AnyValueMap GetAsMap ()
 Converts object value into AnyMap or returns empty AnyMap if conversion is not possible. More...
 
override bool Equals (object obj)
 Compares this object value to specified specified value. When direct comparison gives negative results it tries to compare values as strings. More...
 
bool EqualsAs< T > (object obj)
 ompares this object value to specified specified value. When direct comparison gives negative results it converts values to type specified by type code and compare them again. More...
 
override string ToString ()
 Gets a string representation of the object. More...
 
override int GetHashCode ()
 Gets an object hash code which can be used to optimize storing and searching. More...
 
object Clone ()
 Creates a binary clone of this object. More...
 

Properties

object Value [get, private set]
 The value stored by this object. More...
 

Detailed Description

Cross-language implementation of dynamic object what can hold value of any type. The stored value can be converted to different types using variety of accessor methods.

var value1 = new AnyValue("123.456");
value1.GetAsInteger(); // Result: 123
value1.GetAsString(); // Result: "123.456"
value1.GetAsFloat(); // Result: 123.456

See StringConverter, BooleanConverter, IntegerConverter, LongConverter, DoubleConverter, FloatConverter, DateTimeConverter, ICloneable

Constructor & Destructor Documentation

◆ AnyValue() [1/2]

PipServices3.Commons.Data.AnyValue.AnyValue ( object  value = null)

Creates a new instance of the object and assigns its value.

Parameters
value(optional) value to initialize this object.

◆ AnyValue() [2/2]

PipServices3.Commons.Data.AnyValue.AnyValue ( AnyValue  value)

Creates a new instance of the object and assigns its value.

Parameters
value(optional) value to initialize this object.

Member Function Documentation

◆ Clone()

object PipServices3.Commons.Data.AnyValue.Clone ( )

Creates a binary clone of this object.

Returns
a clone of this object.

Implements PipServices3.Commons.Data.ICloneable.

◆ Equals()

override bool PipServices3.Commons.Data.AnyValue.Equals ( object  obj)

Compares this object value to specified specified value. When direct comparison gives negative results it tries to compare values as strings.

Parameters
objthe value to be compared with.
Returns
true when objects are equal and false otherwise.

◆ EqualsAs< T >()

bool PipServices3.Commons.Data.AnyValue.EqualsAs< T > ( object  obj)

ompares this object value to specified specified value. When direct comparison gives negative results it converts values to type specified by type code and compare them again.

Template Parameters
Tthe class type
Parameters
objthe value to be compared with.
Returns
true when objects are equal and false otherwise.

See TypeConverter.ToType<T>(object)

◆ GetAsArray()

AnyValueArray PipServices3.Commons.Data.AnyValue.GetAsArray ( )

Converts object value into an AnyArray or returns empty AnyArray if conversion is not possible.

Returns
AnyArray value or empty AnyArray if conversion is not supported.

See AnyValueArray.FromValue(object)

◆ GetAsBoolean()

bool PipServices3.Commons.Data.AnyValue.GetAsBoolean ( )

Converts object value into a boolean or returns false if conversion is not possible.

Returns
string value or false if conversion is not supported.

See GetAsBooleanWithDefault(bool)

◆ GetAsBooleanWithDefault()

bool PipServices3.Commons.Data.AnyValue.GetAsBooleanWithDefault ( bool  defaultValue)

Converts object value into a boolean or returns default value if conversion is not possible.

Parameters
defaultValuethe default value
Returns
boolean value or default if conversion is not supported.

See BooleanConverter.ToBooleanWithDefault(object, bool)

◆ GetAsDateTime()

DateTime PipServices3.Commons.Data.AnyValue.GetAsDateTime ( )

Converts object value into a Date or returns current date if conversion is not possible.

Returns
DateTime value or current date if conversion is not supported.

See GetAsDateTimeWithDefault(DateTime?)

◆ GetAsDateTimeWithDefault()

DateTime PipServices3.Commons.Data.AnyValue.GetAsDateTimeWithDefault ( DateTime?  defaultValue)

Converts object value into a Date or returns default value if conversion is not possible.

Parameters
defaultValuethe default value
Returns
DateTime value or default if conversion is not supported.

See DateTimeConverter.ToDateTimeWithDefault(object, DateTime?)

◆ GetAsDouble()

double PipServices3.Commons.Data.AnyValue.GetAsDouble ( )

Converts object value into a double or returns 0 if conversion is not possible.

Returns
double value or 0 if conversion is not supported.

See GetAsDoubleWithDefault(double)

◆ GetAsDoubleWithDefault()

double PipServices3.Commons.Data.AnyValue.GetAsDoubleWithDefault ( double  defaultValue)

Converts object value into a double or returns default value if conversion is not possible.

Parameters
defaultValuethe default value
Returns
double value or default if conversion is not supported.

See DoubleConverter.ToDoubleWithDefault(object, double)

◆ GetAsFloat()

float PipServices3.Commons.Data.AnyValue.GetAsFloat ( )

Converts object value into a float or returns 0 if conversion is not possible.

Returns
float value or 0 if conversion is not supported.

See GetAsFloatWithDefault(float)

◆ GetAsFloatWithDefault()

float PipServices3.Commons.Data.AnyValue.GetAsFloatWithDefault ( float  defaultValue)

Converts object value into a float or returns default value if conversion is not possible.

Parameters
defaultValuethe default value
Returns
float value or default if conversion is not supported.

See FloatConverter.ToFloatWithDefault(object, float)

◆ GetAsInteger()

int PipServices3.Commons.Data.AnyValue.GetAsInteger ( )

onverts object value into an integer or returns 0 if conversion is not possible.

Returns
integer value or 0 if conversion is not supported.

See GetAsIntegerWithDefault(int)

◆ GetAsIntegerWithDefault()

int PipServices3.Commons.Data.AnyValue.GetAsIntegerWithDefault ( int  defaultValue)

Converts object value into a integer or returns default value if conversion is not possible.

Parameters
defaultValuethe default value
Returns
integer value or default if conversion is not supported.

◆ GetAsLong()

long PipServices3.Commons.Data.AnyValue.GetAsLong ( )

Converts object value into a long or returns 0 if conversion is not possible.

Returns
string value or 0 if conversion is not supported.

See GetAsLongWithDefault(long)

◆ GetAsLongWithDefault()

long PipServices3.Commons.Data.AnyValue.GetAsLongWithDefault ( long  defaultValue)

Converts object value into a long or returns default value if conversion is not possible.

Parameters
defaultValuethe default value
Returns
long value or default if conversion is not supported.

See LongConverter.ToLongWithDefault(object, long)

◆ GetAsMap()

AnyValueMap PipServices3.Commons.Data.AnyValue.GetAsMap ( )

Converts object value into AnyMap or returns empty AnyMap if conversion is not possible.

Returns
AnyMap value or empty AnyMap if conversion is not supported.

See AnyValueMap.FromValue(object)

◆ GetAsNullableBoolean()

bool PipServices3.Commons.Data.AnyValue.GetAsNullableBoolean ( )

Converts object value into a boolean or returns null if conversion is not possible.

Returns
boolean value or null if conversion is not supported.

See BooleanConverter.ToNullableBoolean(object)

◆ GetAsNullableDateTime()

DateTime PipServices3.Commons.Data.AnyValue.GetAsNullableDateTime ( )

Converts object value into a Date or returns null if conversion is not possible.

Returns
DateTime value or null if conversion is not supported.

See DateTimeConverter.ToNullableDateTime(object)

◆ GetAsNullableDouble()

double PipServices3.Commons.Data.AnyValue.GetAsNullableDouble ( )

Converts object value into a double or returns null if conversion is not possible.

Returns
double value or null if conversion is not supported.

See DoubleConverter.ToNullableDouble(object)

◆ GetAsNullableFloat()

float PipServices3.Commons.Data.AnyValue.GetAsNullableFloat ( )

Converts object value into a float or returns null if conversion is not possible.

Returns
float value or null if conversion is not supported.

See FloatConverter.ToNullableFloat(object)

◆ GetAsNullableInteger()

int PipServices3.Commons.Data.AnyValue.GetAsNullableInteger ( )

Converts object value into an integer or returns null if conversion is not possible.

Returns
integer value or null if conversion is not supported.

See IntegerConverter.ToNullableInteger(object)

◆ GetAsNullableLong()

long PipServices3.Commons.Data.AnyValue.GetAsNullableLong ( )

Converts object value into a long or returns null if conversion is not possible.

Returns
long value or null if conversion is not supported.

See LongConverter.ToNullableLong(object)

◆ GetAsNullableString()

string PipServices3.Commons.Data.AnyValue.GetAsNullableString ( )

Converts object value into a string or returns null if conversion is not possible.

Returns
string value or null if conversion is not supported.

See StringConverter.ToNullableString(object)

◆ GetAsNullableType< T >()

T PipServices3.Commons.Data.AnyValue.GetAsNullableType< T > ( )

Converts object value into a value defined by specied typecode. If conversion is not possible it returns null.

Template Parameters
Tthe class type
Returns
value defined by the typecode or null if conversion is not supported.

See TypeConverter.ToNullableType<T>(object)

Type Constraints
T :struct 

◆ GetAsObject()

object PipServices3.Commons.Data.AnyValue.GetAsObject ( )

Gets the value stored in this object without any conversions

Returns
the object value.

◆ GetAsString()

string PipServices3.Commons.Data.AnyValue.GetAsString ( )

Converts object value into a string or returns "" if conversion is not possible.

Returns
string value or "" if conversion is not supported.

See GetAsStringWithDefault(string)

◆ GetAsStringWithDefault()

string PipServices3.Commons.Data.AnyValue.GetAsStringWithDefault ( string  defaultValue)

Converts object value into a string or returns default value if conversion is not possible.

Parameters
defaultValuethe default value.
Returns
string value or default if conversion is not supported.

See StringConverter.ToStringWithDefault(object, string)

◆ GetAsType< T >()

T PipServices3.Commons.Data.AnyValue.GetAsType< T > ( )

Converts object value into a value defined by specied typecode. If conversion is not possible it returns default value for the specified type.

Template Parameters
Tthe class type
Returns
value defined by the typecode or type default value if conversion is not supported.

See TypeConverter.ToType<T>(object)

Type Constraints
T :struct 

◆ GetAsTypeWithDefault< T >()

T PipServices3.Commons.Data.AnyValue.GetAsTypeWithDefault< T > ( defaultValue)

Converts object value into a value defined by specied typecode. If conversion is not possible it returns default value.

Template Parameters
Tthe class type
Parameters
defaultValuethe default value
Returns
value defined by the typecode or type default value if conversion is not supported.
Type Constraints
T :struct 

◆ GetHashCode()

override int PipServices3.Commons.Data.AnyValue.GetHashCode ( )

Gets an object hash code which can be used to optimize storing and searching.

Returns
an object hash code.

◆ SetAsObject()

void PipServices3.Commons.Data.AnyValue.SetAsObject ( object  value)

Sets a new value for this object

Parameters
valuethe new object value.

◆ ToString()

override string PipServices3.Commons.Data.AnyValue.ToString ( )

Gets a string representation of the object.

Returns
a string representation of the object.

See StringConverter.ToString(object)

Property Documentation

◆ Value

object PipServices3.Commons.Data.AnyValue.Value
getprivate set

The value stored by this object.


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