Models the copyright part of an help text. You can assign it where you assign any System.String instance. More...

Public Member Functions
	CopyrightInfo (string author, int year)
	Initializes a new instance of the CommandLine.Text.CopyrightInfo class specifying author and year.

	CopyrightInfo (string author, params int[] years)
	Initializes a new instance of the CommandLine.Text.CopyrightInfo class specifying author and copyrightYears.

	CopyrightInfo (bool isSymbolUpper, string author, params int[] copyrightYears)
	Initializes a new instance of the CommandLine.Text.CopyrightInfo class specifying symbol case, author and copyrightYears.

override string	ToString ()
	Returns the copyright as a System.String.

Static Public Member Functions
static implicit	operator string (CopyrightInfo info)
	Converts the copyright instance to a System.String.

Protected Member Functions
	CopyrightInfo ()
	Initializes a new instance of the CommandLine.Text.CopyrightInfo class.

virtual string	FormatYears (int[] years)
	When overridden in a derived class, allows to specify a new algorithm to render copyright copyrightYears as a System.String instance.

Properties
static CopyrightInfo	Empty `[get]`
	An empty object used for initialization.

static CopyrightInfo	Default `[get]`
	Gets the default copyright information. Retrieved from AssemblyCopyrightAttribute, if it exists, otherwise it uses AssemblyCompanyAttribute as copyright holder with the current year. If neither exists it throws an InvalidOperationException.

virtual string	CopyrightWord `[get]`
	Gets a different copyright word when overridden in a derived class.

Private Member Functions
	CopyrightInfo (AssemblyCopyrightAttribute attribute)
	Initializes a new instance of the CommandLine.Text.CopyrightInfo class with an assembly attribute, this overrides all formatting.

Private Attributes
readonly AssemblyCopyrightAttribute	attribute

readonly string	author

readonly int	builderSize

readonly int[]	copyrightYears

readonly bool	isSymbolUpper

Static Private Attributes
const string	DefaultCopyrightWord = "Copyright"

const string	SymbolLower = "(c)"

const string	SymbolUpper = "(C)"

Detailed Description

Models the copyright part of an help text. You can assign it where you assign any System.String instance.

Definition at line 18 of file CopyrightInfo.cs.

Constructor & Destructor Documentation

◆ CopyrightInfo() [1/5]

CommandLine.Text.CopyrightInfo.CopyrightInfo	(	string	author,
		int	year
	)

Initializes a new instance of the CommandLine.Text.CopyrightInfo class specifying author and year.

Parameters

author	The company or person holding the copyright.
year	The year of coverage of copyright.

Exceptions

System.ArgumentException Thrown when parameter author is null or empty string.

Definition at line 36 of file CopyrightInfo.cs.

37 : this(true, author, year) { }

CommandLine.Text.CopyrightInfo.author

readonly string author

Definition CopyrightInfo.cs:24

◆ CopyrightInfo() [2/5]

CommandLine.Text.CopyrightInfo.CopyrightInfo	(	string	author,
		params int[]	years
	)

Initializes a new instance of the CommandLine.Text.CopyrightInfo class specifying author and copyrightYears.

Parameters

author	The company or person holding the copyright.
years	The copyrightYears of coverage of copyright.

Exceptions

System.ArgumentException	Thrown when parameter author is null or empty string.
System.ArgumentOutOfRangeException	Thrown when parameter years is not supplied.

Definition at line 47 of file CopyrightInfo.cs.

48 : this(true, author, years) { }

◆ CopyrightInfo() [3/5]

CommandLine.Text.CopyrightInfo.CopyrightInfo	(	bool	isSymbolUpper,
		string	author,
		params int[]	copyrightYears
	)

Initializes a new instance of the CommandLine.Text.CopyrightInfo class specifying symbol case, author and copyrightYears.

Parameters

isSymbolUpper	The case of the copyright symbol.
author	The company or person holding the copyright.
copyrightYears	The copyrightYears of coverage of copyright.

Exceptions

System.ArgumentException	Thrown when parameter author is null or empty string.
System.ArgumentOutOfRangeException	Thrown when parameter copyrightYears is not supplied.

Definition at line 62 of file CopyrightInfo.cs.

        {
            if (string.IsNullOrWhiteSpace(author))
            {
                throw new ArgumentException("author");
            }
 
            if (copyrightYears.Length == 0)
            {
                throw new ArgumentOutOfRangeException("copyrightYears");
            }
 
            const int ExtraLength = 10;
            this.isSymbolUpper = isSymbolUpper;
            this.author = author;
            this.copyrightYears = copyrightYears;
            builderSize = 12 + author.Length + 4 * copyrightYears.Length + ExtraLength;
        }

◆ CopyrightInfo() [4/5]

CommandLine.Text.CopyrightInfo.CopyrightInfo ( )

protected

Initializes a new instance of the CommandLine.Text.CopyrightInfo class.

Definition at line 84 of file CopyrightInfo.cs.

84{ }

◆ CopyrightInfo() [5/5]

CommandLine.Text.CopyrightInfo.CopyrightInfo ( AssemblyCopyrightAttribute attribute )

private

Initializes a new instance of the CommandLine.Text.CopyrightInfo class with an assembly attribute, this overrides all formatting.

Parameters

attribute The attribute which text to use.

Definition at line 91 of file CopyrightInfo.cs.

        {
            this.attribute = attribute;
        }

Member Function Documentation

◆ FormatYears()

virtual string CommandLine.Text.CopyrightInfo.FormatYears ( int[] years )

protectedvirtual

When overridden in a derived class, allows to specify a new algorithm to render copyright copyrightYears as a System.String instance.

Parameters

years A System.Int32 array of copyrightYears.

Returns: A System.String instance with copyright copyrightYears.

Definition at line 178 of file CopyrightInfo.cs.

        {
            if (years.Length == 1)
            {
                return years[0]
                    .ToString(CultureInfo.InvariantCulture);
            }
 
            StringBuilder yearsPart = new StringBuilder(years.Length * 6);
 
            for (int i = 0; i < years.Length; i++)
            {
                yearsPart.Append(years[i]
                                     .ToString(CultureInfo.InvariantCulture)
                                );
                int next = i + 1;
 
                if (next < years.Length)
                {
                    yearsPart.Append(years[next] - years[i] > 1 ? " - " : ", ");
                }
            }
 
            return yearsPart.ToString();
        }

◆ operator string()

static implicit CommandLine.Text.CopyrightInfo.operator string ( CopyrightInfo info )

static

Converts the copyright instance to a System.String.

Parameters

info	This CommandLine.Text.CopyrightInfo instance.

Returns: The System.String that contains the copyright.

Definition at line 145 of file CopyrightInfo.cs.

        {
            return info.ToString();
        }

◆ ToString()

override string CommandLine.Text.CopyrightInfo.ToString ( )

Returns the copyright as a System.String.

Returns: The System.String that contains the copyright.

Definition at line 154 of file CopyrightInfo.cs.

        {
            if (attribute != null)
            {
                return attribute.Copyright;
            }
 
            return new StringBuilder(builderSize)
                   .Append(CopyrightWord)
                   .Append(' ')
                   .Append(isSymbolUpper ? SymbolUpper : SymbolLower)
                   .Append(' ')
                   .Append(FormatYears(copyrightYears))
                   .Append(' ')
                   .Append(author)
                   .ToString();
        }

Member Data Documentation

◆ attribute

readonly AssemblyCopyrightAttribute CommandLine.Text.CopyrightInfo.attribute

private

Definition at line 23 of file CopyrightInfo.cs.

◆ author

readonly string CommandLine.Text.CopyrightInfo.author

private

Definition at line 24 of file CopyrightInfo.cs.

◆ builderSize

readonly int CommandLine.Text.CopyrightInfo.builderSize

private

Definition at line 25 of file CopyrightInfo.cs.

◆ copyrightYears

readonly int [] CommandLine.Text.CopyrightInfo.copyrightYears

private

Definition at line 26 of file CopyrightInfo.cs.

◆ DefaultCopyrightWord

const string CommandLine.Text.CopyrightInfo.DefaultCopyrightWord = "Copyright"

staticprivate

Definition at line 20 of file CopyrightInfo.cs.

◆ isSymbolUpper

readonly bool CommandLine.Text.CopyrightInfo.isSymbolUpper

private

Definition at line 27 of file CopyrightInfo.cs.

◆ SymbolLower

const string CommandLine.Text.CopyrightInfo.SymbolLower = "(c)"

staticprivate

Definition at line 21 of file CopyrightInfo.cs.

◆ SymbolUpper

const string CommandLine.Text.CopyrightInfo.SymbolUpper = "(C)"

staticprivate

Definition at line 22 of file CopyrightInfo.cs.

Property Documentation

◆ CopyrightWord

virtual string CommandLine.Text.CopyrightInfo.CopyrightWord

getprotected

Gets a different copyright word when overridden in a derived class.

Definition at line 138 of file CopyrightInfo.cs.

◆ Default

CopyrightInfo CommandLine.Text.CopyrightInfo.Default

staticget

Gets the default copyright information. Retrieved from AssemblyCopyrightAttribute, if it exists, otherwise it uses AssemblyCompanyAttribute as copyright holder with the current year. If neither exists it throws an InvalidOperationException.

Definition at line 107 of file CopyrightInfo.cs.

        {
            get
            {
                // if an exact copyright string has been specified, it takes precedence
                Maybe<AssemblyCopyrightAttribute> copyrightAttr =
                    ReflectionHelper.GetAttribute<AssemblyCopyrightAttribute>();
 
                switch (copyrightAttr.Tag)
                {
                    case MaybeType.Just:
                        return new CopyrightInfo(copyrightAttr.FromJustOrFail());
                    default:
                        Maybe<AssemblyCompanyAttribute> companyAttr =
                            ReflectionHelper.GetAttribute<AssemblyCompanyAttribute>();
 
                        return companyAttr.IsNothing()
                                   //if both copyrightAttr and companyAttr aren't available in Assembly,don't fire Exception
                                   ? Empty
                                   // if no copyright attribute exist but a company attribute does, use it as copyright holder
                                   : new CopyrightInfo(companyAttr.FromJust()
                                                                  .Company,
                                                       DateTime.Now.Year
                                                      );
                }
            }
        }

◆ Empty

CopyrightInfo CommandLine.Text.CopyrightInfo.Empty

staticget

An empty object used for initialization.

Definition at line 99 of file CopyrightInfo.cs.

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

deps/commandlineparser/src/CommandLine/Text/CopyrightInfo.cs

Public Member Functions

Static Public Member Functions

Protected Member Functions

Properties

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CopyrightInfo() [1/5]

◆ CopyrightInfo() [2/5]

◆ CopyrightInfo() [3/5]

◆ CopyrightInfo() [4/5]

◆ CopyrightInfo() [5/5]

Member Function Documentation

◆ FormatYears()

◆ operator string()

◆ ToString()

Member Data Documentation

◆ attribute

◆ author

◆ builderSize

◆ copyrightYears

◆ DefaultCopyrightWord

◆ isSymbolUpper

◆ SymbolLower

◆ SymbolUpper

Property Documentation

◆ CopyrightWord

◆ Default

◆ Empty