Example.cs

Go to the documentation of this file.

// Copyright 2005-2015 Giacomo Stelluti Scala & Contributors. All rights reserved. See License.md in the project root for license information.
 
using System;
using System.Collections.Generic;
using System.Linq;
 
namespace CommandLine.Text
{
    public sealed class Example : IEquatable<Example>
    {
        public Example(string helpText, IEnumerable<UnParserSettings> formatStyles, object sample)
        {
            if (string.IsNullOrEmpty(helpText))
            {
                throw new ArgumentException("helpText can't be null or empty", "helpText");
            }
 
            if (formatStyles == null)
            {
                throw new ArgumentNullException("formatStyles");
            }
 
            if (sample == null)
            {
                throw new ArgumentNullException("sample");
            }
 
            HelpText = helpText;
            FormatStyles = formatStyles;
            Sample = sample;
        }
 
        public Example(string helpText, UnParserSettings formatStyle, object sample)
            : this(helpText,
                   new[] { formatStyle },
                   sample
                  ) { }
 
        public Example(string helpText, object sample)
            : this(helpText, Enumerable.Empty<UnParserSettings>(), sample) { }
 
        public string HelpText { get; }
 
        public IEnumerable<UnParserSettings> FormatStyles { get; }
 
        public object Sample { get; }
 
#region IEquatable<Example> Members
 
        public bool Equals(Example other)
        {
            if (other == null)
            {
                return false;
            }
 
            return HelpText.Equals(other.HelpText) &&
                   FormatStyles.SequenceEqual(other.FormatStyles) &&
                   Sample.Equals(other.Sample);
        }
 
#endregion
 
        public override bool Equals(object obj)
        {
            Example other = obj as Example;
 
            if (other != null)
            {
                return Equals(other);
            }
 
            return base.Equals(obj);
        }
 
        public override int GetHashCode()
        {
            return new { HelpText, FormatStyles, Sample }.GetHashCode();
        }
    }
 
    internal static class ExampleExtensions
    {
        public static IEnumerable<UnParserSettings> GetFormatStylesOrDefault(this Example example)
        {
            return example.FormatStyles.Any()
                       ? example.FormatStyles
                       : new[] { new UnParserSettings { Consumed = true } };
        }
    }
}