pluginbase.Helpers.Data.AnyEnum Class Reference

Object that can act as any enumeration More...

Inheritance diagram for pluginbase.Helpers.Data.AnyEnum:

Public Member Functions
	AnyEnum ()
T	ToEnum< T > ()
	Convert AnyEnum to a typed enumeration More...
T	ToOtherEnum< T > ()
	Convert AnyEnum to a typed enumeration, though not necessarily of the same type as the original type More...
bool	Is (Enum other)
	Determines whether this instance is the same as other. More...
bool	Equals (AnyEnum other)
	Determines whether the specified pluginbase.Helpers.Data.AnyEnum is equal to the current pluginbase.Helpers.Data.AnyEnum. More...
bool	Equals (Enum other)
	Determines whether the specified System.Enum is equal to the current pluginbase.Helpers.Data.AnyEnum. More...
override bool	Equals (object obj)
	Determines whether the specified System.Object is equal to the current pluginbase.Helpers.Data.AnyEnum. More...
override int	GetHashCode ()
	Serves as a hash function for a pluginbase.Helpers.Data.AnyEnum object. More...
override string	ToString ()
	Returns a System.String that represents the current pluginbase.Helpers.Data.AnyEnum. More...

Static Public Member Functions
static implicit	operator AnyEnum (Enum @enum)
	Convert an enum to an AnyEnum instance More...
static implicit	operator string (AnyEnum any)
	Convert an AnyEnum instance to a string More...
static	operator AnyEnum (string str)
	Convert a string to an anyenum instance More...
static AnyEnum	FromString (string str)
	Get an AnyEnum instance from a previous ToString More...
static AnyEnum	Impersonate (Type type, string val)
	Impersonate an enumeration. Only null-check validation More...
static AnyEnum	Impersonate (string typeName, string val)
	Impersonate an enumeration. Only null-check validation More...
static bool	operator== (AnyEnum left, AnyEnum right)
	Checks if the left enum is equivilant to the right More...
static bool	operator== (AnyEnum left, Enum right)
	Checks if the left enum is equivilant to the right More...
static bool	operator== (Enum left, AnyEnum right)
	Checks if the left enum is equivilant to the right More...
static bool	operator!= (AnyEnum left, AnyEnum right)
	Checks if the left enum is not equivilant to the right More...
static bool	operator!= (AnyEnum left, Enum right)
	Checks if the left enum is not equivilant to the right More...
static bool	operator!= (Enum left, AnyEnum right)
	Checks if the left enum is not equivilant to the right More...

Detailed Description

Object that can act as any enumeration

Attribute: TypeConverter(typeof(AnyEnumTypeConverter))

Constructor & Destructor Documentation

AnyEnum()

pluginbase.Helpers.Data.AnyEnum.AnyEnum

(

)

        { }

Member Function Documentation

Equals() [1/3]

bool pluginbase.Helpers.Data.AnyEnum.Equals

(

AnyEnum

other

)

Determines whether the specified pluginbase.Helpers.Data.AnyEnum is equal to the current pluginbase.Helpers.Data.AnyEnum.

Parameters

other

The pluginbase.Helpers.Data.AnyEnum to compare with the current pluginbase.Helpers.Data.AnyEnum.

Returns

true if the specified pluginbase.Helpers.Data.AnyEnum is equal to the current pluginbase.Helpers.Data.AnyEnum; otherwise, false.

        {
            return other._type == this._type && other._value == this._value;
        }

Equals() [2/3]

bool pluginbase.Helpers.Data.AnyEnum.Equals

(

Enum

other

)

Determines whether the specified System.Enum is equal to the current pluginbase.Helpers.Data.AnyEnum.

Parameters

other

The System.Enum to compare with the current pluginbase.Helpers.Data.AnyEnum.

Returns

true if the specified System.Enum is equal to the current pluginbase.Helpers.Data.AnyEnum; otherwise, false.

        {
            if (other == null)
                return false;

            return other.GetType().Name == this._type && other.ToString() == this._value;
        }

Equals() [3/3]

override bool pluginbase.Helpers.Data.AnyEnum.Equals

(

object

obj

)

Determines whether the specified System.Object is equal to the current pluginbase.Helpers.Data.AnyEnum.

Parameters

obj	The System.Object to compare with the current pluginbase.Helpers.Data.AnyEnum.

Returns

true if the specified System.Object is equal to the current pluginbase.Helpers.Data.AnyEnum; otherwise, false.

        {
            AnyEnum other = obj as AnyEnum;
            if (other != null)
                return this.Equals(other);

            Enum otherEnum = obj as Enum;
            if (otherEnum != null)
                return this.Equals(otherEnum);

            return false;
        }

FromString()

static AnyEnum pluginbase.Helpers.Data.AnyEnum.FromString ( string  str )

static

Get an AnyEnum instance from a previous ToString

Returns

The string.

Parameters

str

String.

        {
            if (string.IsNullOrEmpty(str))
                throw new ArgumentNullException("str");

            int last = str.LastIndexOf('#');

            if (last < 0)
                throw new FormatException("Enum string formatted incorrectly");


            string typeString = str.Substring(0, last);

            if (string.IsNullOrWhiteSpace(typeString))
                throw new FormatException("Invalid enum type");

            string val = str.Substring(last + 1);

            if (string.IsNullOrWhiteSpace(val))
                throw new FormatException("Invalid enum value");

            return new AnyEnum(typeString, val);
        }

GetHashCode()

override int pluginbase.Helpers.Data.AnyEnum.GetHashCode

(

)

Serves as a hash function for a pluginbase.Helpers.Data.AnyEnum object.

Returns

A hash code for this instance that is suitable for use in hashing algorithms and data structures such as a hash table.

        {
            return _type.GetHashCode() ^ _value.GetHashCode();
        }

Impersonate() [1/2]

static AnyEnum pluginbase.Helpers.Data.AnyEnum.Impersonate ( Type  type, string  val  )

static

Impersonate an enumeration. Only null-check validation

Parameters

type	Type.
val	Value.

        {
            if (!type.IsEnum)
                throw new ArgumentException("Type not enum");
            if (string.IsNullOrEmpty(val))
                throw new ArgumentNullException("val");
            return new AnyEnum(type.Name, val);
        }

Impersonate() [2/2]

static AnyEnum pluginbase.Helpers.Data.AnyEnum.Impersonate ( string  typeName, string  val  )

static

Impersonate an enumeration. Only null-check validation

Parameters

typeName	Type full name.
val	Value.

        {
            if (string.IsNullOrEmpty(typeName))
                throw new ArgumentNullException("typeName");
            if (string.IsNullOrEmpty(val))
                throw new ArgumentNullException("val");
            return new AnyEnum(typeName, val);
        }

Is()

bool pluginbase.Helpers.Data.AnyEnum.Is

(

Enum

other

)

Determines whether this instance is the same as other.

Returns

true if this instance is other; otherwise, false.

Parameters

other

Other.

        {
            return this.Equals(other);
        }

operator AnyEnum() [1/2]

static implicit pluginbase.Helpers.Data.AnyEnum.operator AnyEnum ( Enum @  enum )

static

Convert an enum to an AnyEnum instance

        {
            return new AnyEnum(@enum);
        }

operator AnyEnum() [2/2]

static pluginbase.Helpers.Data.AnyEnum.operator AnyEnum ( string  str )

explicitstatic

Convert a string to an anyenum instance

        {
            return AnyEnum.FromString(str);
        }

operator string()

static implicit pluginbase.Helpers.Data.AnyEnum.operator string ( AnyEnum  any )

static

Convert an AnyEnum instance to a string

        {
            return any.ToString();
        }

operator!=() [1/3]

static bool pluginbase.Helpers.Data.AnyEnum.operator!= ( AnyEnum  left, AnyEnum  right  )

static

Checks if the left enum is not equivilant to the right

        {
            return !left.Equals(right);
        }

operator!=() [2/3]

static bool pluginbase.Helpers.Data.AnyEnum.operator!= ( AnyEnum  left, Enum  right  )

static

Checks if the left enum is not equivilant to the right

        {
            return !left.Equals(right);
        }

operator!=() [3/3]

static bool pluginbase.Helpers.Data.AnyEnum.operator!= ( Enum  left, AnyEnum  right  )

static

Checks if the left enum is not equivilant to the right

        {
            return !right.Equals(left);
        }

operator==() [1/3]

static bool pluginbase.Helpers.Data.AnyEnum.operator== ( AnyEnum  left, AnyEnum  right  )

static

Checks if the left enum is equivilant to the right

        {
            return left.Equals(right);
        }

operator==() [2/3]

static bool pluginbase.Helpers.Data.AnyEnum.operator== ( AnyEnum  left, Enum  right  )

static

Checks if the left enum is equivilant to the right

        {
            return left.Equals(right);
        }

operator==() [3/3]

static bool pluginbase.Helpers.Data.AnyEnum.operator== ( Enum  left, AnyEnum  right  )

static

Checks if the left enum is equivilant to the right

        {
            return right.Equals(left);
        }

ToEnum< T >()

T pluginbase.Helpers.Data.AnyEnum.ToEnum< T >

(

)

Convert AnyEnum to a typed enumeration

Returns

The enum.

Template Parameters

T	The enumeration type.

        {
            if (!typeof(T).IsEnum)
                throw new ArgumentException("T must be of type Enum");
            if (typeof(T).Name != this._type)
                throw new InvalidCastException("T does not match internal type");
            return (T)Enum.Parse(typeof(T), _value);
        }

ToOtherEnum< T >()

T pluginbase.Helpers.Data.AnyEnum.ToOtherEnum< T >

(

)

Convert AnyEnum to a typed enumeration, though not necessarily of the same type as the original type

Returns

The other enum.

Template Parameters

T	The enumeration type.

        {
            if (!typeof(T).IsEnum)
                throw new ArgumentException("T must be of type Enum");
            return (T)Enum.Parse(typeof(T), _value);
        }

ToString()

override string pluginbase.Helpers.Data.AnyEnum.ToString

(

)

Returns a System.String that represents the current pluginbase.Helpers.Data.AnyEnum.

Returns

A System.String that represents the current pluginbase.Helpers.Data.AnyEnum.

        {
            return string.Format("{0}#{1}", _type, _value);
        }

---

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

• pluginbase/Helpers/Data/AnyEnum.cs