BadScript2.ConsoleAbstraction.BadConsole Class Reference

Wrapper class for the console abstraction. More...

Classes
class	BadDummyConsole

Static Public Member Functions
static IBadConsole	GetConsole ()
	Returns the Current Console Implementation.
static void	SetConsole (IBadConsole console)
	Sets the Current Console Implementation.
static void	Write (string str)
	Writes a string to the console.
static void	WriteLine (string str)
	Writes a string to the console and appends a newline.
static string	ReadLine ()
	Reads a line from the console.
static Task< string >	ReadLineAsync ()
	Reads a line from the console asynchronously.
static void	Clear ()
	Clears the console.

Static Public Attributes
static readonly IBadConsole	DummyConsole = new BadDummyConsole()

Properties
static ConsoleColor	ForegroundColor [get, set]
	The Foreground Color.
static ConsoleColor	BackgroundColor [get, set]
	The Background Color.

Static Private Member Functions
static	BadConsole ()
	Static Constructor.

Static Private Attributes
static IBadConsole	s_Console
	The Console Implementation that is used.

Detailed Description

Wrapper class for the console abstraction.

Definition at line 11 of file BadConsole.cs.

Constructor & Destructor Documentation

BadConsole()

static BadScript2.ConsoleAbstraction.BadConsole.BadConsole ( )

staticprivate

Static Constructor.

Definition at line 23 of file BadConsole.cs.

    {
        s_Console = new BadSystemConsole();
    }

Member Function Documentation

Clear()

static void BadScript2.ConsoleAbstraction.BadConsole.Clear ( )

static

Clears the console.

Definition at line 104 of file BadConsole.cs.

    {
        s_Console.Clear();
    }

GetConsole()

static IBadConsole BadScript2.ConsoleAbstraction.BadConsole.GetConsole ( )

static

Returns the Current Console Implementation.

Returns

Console Implementation

Definition at line 51 of file BadConsole.cs.

    {
        return s_Console;
    }

ReadLine()

static string BadScript2.ConsoleAbstraction.BadConsole.ReadLine ( )

static

Reads a line from the console.

Returns

The line that was read

Definition at line 87 of file BadConsole.cs.

    {
        return s_Console.ReadLine();
    }

ReadLineAsync()

static Task< string > BadScript2.ConsoleAbstraction.BadConsole.ReadLineAsync ( )

static

Reads a line from the console asynchronously.

Returns

The line that was read

Definition at line 96 of file BadConsole.cs.

    {
        return s_Console.ReadLineAsync();
    }

SetConsole()

static void BadScript2.ConsoleAbstraction.BadConsole.SetConsole ( IBadConsole  console )

static

Sets the Current Console Implementation.

Parameters

console

The new Console Implementation that will be used.

Definition at line 60 of file BadConsole.cs.

    {
        s_Console = console;
    }

Write()

static void BadScript2.ConsoleAbstraction.BadConsole.Write ( string  str )

static

Writes a string to the console.

Parameters

str	The String to be written

Definition at line 69 of file BadConsole.cs.

    {
        s_Console.Write(str);
    }

WriteLine()

static void BadScript2.ConsoleAbstraction.BadConsole.WriteLine ( string  str )

static

Writes a string to the console and appends a newline.

Parameters

str	The String to be written

Definition at line 78 of file BadConsole.cs.

    {
        s_Console.WriteLine(str);
    }

Member Data Documentation

DummyConsole

readonly IBadConsole BadScript2.ConsoleAbstraction.BadConsole.DummyConsole = new BadDummyConsole()

static

Definition at line 13 of file BadConsole.cs.

s_Console

IBadConsole BadScript2.ConsoleAbstraction.BadConsole.s_Console

staticprivate

The Console Implementation that is used.

Definition at line 18 of file BadConsole.cs.

Property Documentation

BackgroundColor

ConsoleColor BadScript2.ConsoleAbstraction.BadConsole.BackgroundColor

staticgetset

The Background Color.

Definition at line 41 of file BadConsole.cs.

    {
        get => s_Console.BackgroundColor;
        set => s_Console.BackgroundColor = value;
    }

ForegroundColor

ConsoleColor BadScript2.ConsoleAbstraction.BadConsole.ForegroundColor

staticgetset

The Foreground Color.

Definition at line 32 of file BadConsole.cs.

    {
        get => s_Console.ForegroundColor;
        set => s_Console.ForegroundColor = value;
    }

---

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

• src/BadScript2.Common/BadScript2.ConsoleAbstraction/BadConsole.cs