IDumpable Interface in C#

In this article, we will discuss how to implement the IDumpable interface in C#. The IDumpable interface is a simple interface with a Dump() method and public properties. Those classes want to implement the IDumpable interface; they must implement the Dump() method and can use the interface's public properties to manage code execution.

Purpose of IDumpable:

The primary purpose of the IDumpable Interface is to apply contracts to objects that use the Dump method. By using the Dump method, the object's internal state can be captured and interpreted by humans. After that, this string is returned as an output. It is especially useful for debugging, logging, or other situations where we need to understand the contents of an object without investigating its internal structure.

Real-Time Example:

Let us take a real-time example to illustrate the IDumpable Interface in C#. Suppose we are driving a car and want to issue a command to know whether the car should run on petrol/diesel/CNG/electricity. Here, we use the Dump() method to determine the command to drive the car based on the command. Commands are issued through public interface properties at run time. First, define enumeration types for the various commands, and then DriveCommand enumeration defines four commands to drive the car.

Syntax:

It has the following syntax:

Internal enum DriveCmd{
Petrol,
Diesel,
Cng
}

The next step involves creating an IDumpable interface that includes a Dump() method and corresponding public property of the type Command, which is named with the DriveCmd enum.

Public interface IDumpable{
  DriveCmd Cmd{
  Get;
   Set;
   }
   Void Dump();
}

Example:

Let us take an example to illustrate the IDumpable Interface in C#.

using System;

namespace Sample {
internal class Structure{
	internal enum DriveCmd {
		Using_PETROL,
		Using_DIESEL,
		Using_CNG,
		Using_ELECTRIC
	}

	public interface IDumpable {
		DriveCmd Cmd
		{
			get;
			set;
		}
		void Dump();
	}

	public class BMW : IDumpable {
		private DriveCmd _cmd;
		private int _velocity;

		public DriveCmd Cmd
		{
			get { return _cmd; }
			set { _cmd = value; }
		}

		public BMW(int Velocity) { this._velocity = Velocity; }

		public void Dump()
		{
			Console.WriteLine("I AM DRIVING THE BMW");
			Console.WriteLine("Cmd : " + _cmd);

			if (_cmd == DriveCmd.Using_PETROL) {
				Console.WriteLine(
					"BMW CURRENTLY RUNS WITH " + _cmd
					+ " AT A SPEED OF " + _velocity.ToString()
					+ " KM/HR"
					+ "\n");
			}
			else {
					Console.WriteLine("BMW IS NOT SUITABLE TO DRIVE ON " + _cmd + "\n");
			}
		}
	}

	public class TRACTOR : IDumpable {
		private DriveCmd _cmd;
		private int _velocity;

		public DriveCmd Cmd
		{
			get { return _cmd; }
			set { _cmd = value; }
		}

		public TRACTOR(int Velocity) { this._velocity = Velocity; }

		public void Dump()
		{
			Console.WriteLine("I AM DRIVING THE TRACTOR");
			Console.WriteLine("Cmd : " + _cmd);

			if (_cmd == DriveCmd.Using_DIESEL) {
				Console.WriteLine(
					"TRACTOR CURRENTLY RUNS WITH " + _cmd
					+ " WITH A SPEED OF " + _velocity.ToString()
					+ " KM/HR"
					+ "\n");
			}
			else {
				Console.WriteLine(
					"TRACTOR IS NOT SUITABLE TO DRIVE ON "
					+ _cmd + "\n");
			}
		}
	}

	public class TUCSON: IDumpable {
		private DriveCmd _cmd;
		private int _velocity;

		public DriveCmd Cmd
		{
			get { return _cmd; }
			set { _cmd = value; }
		}

		public TUCSON(int Velocity) { this._velocity = Velocity; }

		public void Dump()
		{
			Console.WriteLine("I AM DRIVING THE TUCSON");
			Console.WriteLine("Cmd : " + _cmd);

			if (_cmd == DriveCmd.Using_PETROL
				|| _cmd == DriveCmd.Using_ELECTRIC) {
				Console.WriteLine(
					"TUCSON CURRENTLY RUNS WITH " + _cmd
					+ " WITH SPEED OF " + _velocity.ToString()
					+ " KM/HR"
					+ "\n");
			}
			else {
					Console.WriteLine("TUCSON IS NOT COMPATIBLE TO DRIVE	ON " + _cmd + "\n");
			}
		}
	}

	public class WAGONR : IDumpable {
		private DriveCmd _cmd;
		private int _velocity;

		public DriveCmd Cmd
		{
			get { return _cmd; }
			set { _cmd = value; }
		}

		public WAGONR(int Velocity) { this._velocity= Velocity; }

		public void Dump()
		{
			Console.WriteLine("I AM DRIVING WAGONR");
			Console.WriteLine("Cmd : " + _cmd);

			if (_cmd == DriveCmd.Using_PETROL
				|| _cmd == DriveCmd.Using_CNG) {
				Console.WriteLine(
					"WAGONR CURRENTLY RUNS WITH " + _cmd
					+ " WITH SPEED OF " + _velocity.ToString()
					+ " KM/HR"
					+ "\n");
			}
			else {
					
                                    Console.WriteLine("WAGONR IS NOT SUITABLE TO DRIVE ON " + _cmd + "\n");
			}
		}
	}

	static void Main(string[] args)
	{
		IDumpable Car = new BMW(90);

		Car.Cmd = DriveCmd.Using_PETROL;
		Car.Dump();

		Car.Cmd = DriveCmd.Using_DIESEL;
		Car.Dump();

		Car = new TRACTOR(100);

		Car.Cmd = DriveCmd.Using_DIESEL;
		Car.Dump();

		Car = new TUCSON(80);

		Car.Cmd = DriveCmd.Using_PETROL;
		Car.Dump();

		Car.Cmd = DriveCmd.Using_ELECTRIC;
		Car.Dump();

		Car = new WAGONR(50);

		Car.Cmd = DriveCmd.Using_CNG;
		Car.Dump();

		Console.Read();
	}
}
}

Output:

I AM DRIVING THE BMW
Cmd : Using_PETROL
BMW CURRENTLY RUNS WITH Using_PETROL AT A SPEED OF 90 KM/HR

I AM DRIVING THE BMW
Cmd : Using_DIESEL
BMW IS NOT SUITABLE TO DRIVE ON Using_DIESEL

I AM DRIVING THE TRACTOR
Cmd : Using_DIESEL
TRACTOR CURRENTLY RUNS WITH Using_DIESEL WITH A SPEED OF 100 KM/HR

I AM DRIVING THE TUCSON
Cmd : Using_PETROLTUCSON CURRENTLY RUNS WITH Using_PETROL WITH SPEED OF 80 KM/HR

I AM DRIVING The TUCSON
Cmd : Using_ELECTRIC
TUCSON CURRENTLY RUNS WITH Using_ELECTRIC WITH SPEED OF 80 KM/HR

I AM DRIVING WAGONR
Cmd : Using_CNG
WAGONR CURRENTLY RUNS WITH Using_CNG WITH SPEED OF 50 KM/HR

Next TopicBoolean.GetTypeCode() Method in C#

← prev next →