Files
octokit.net/Octokit/Models/Response/License.cs
2015-03-17 17:53:10 -07:00

105 lines
3.5 KiB
C#

using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Diagnostics;
using System.Globalization;
using System.Linq;
namespace Octokit
{
[DebuggerDisplay("{DebuggerDisplay,nq}")]
public class License : LicenseMetadata
{
public License(
string key,
string name,
Uri url,
Uri htmlUrl,
bool featured,
string description,
string category,
string implementation,
string body,
IEnumerable<string> required,
IEnumerable<string> permitted,
IEnumerable<string> forbidden) : base(key, name, url)
{
Ensure.ArgumentNotNull(htmlUrl, "htmlUrl");
Ensure.ArgumentNotNull(description, "description");
Ensure.ArgumentNotNull(category, "category");
Ensure.ArgumentNotNull(implementation, "implementation");
Ensure.ArgumentNotNull(body, "body");
Ensure.ArgumentNotNull(required, "required");
Ensure.ArgumentNotNull(permitted, "permitted");
Ensure.ArgumentNotNull(forbidden, "forbidden");
HtmlUrl = htmlUrl;
Featured = featured;
Description = description;
Category = category;
Implementation = implementation;
Body = body;
Required = new ReadOnlyCollection<string>(required.ToList());
Permitted = new ReadOnlyCollection<string>(permitted.ToList());
Forbidden = new ReadOnlyCollection<string>(forbidden.ToList());
}
public License()
{
}
/// <summary>
/// Url to the license on https://choosealicense.com
/// </summary>
public Uri HtmlUrl { get; protected set; }
/// <summary>
/// Whether the license is one of the licenses featured on https://choosealicense.com
/// </summary>
public bool Featured { get; protected set; }
/// <summary>
/// A description of the license.
/// </summary>
public string Description { get; protected set; }
/// <summary>
/// A group or family that the license belongs to such as the GPL family of licenses.
/// </summary>
public string Category { get; protected set; }
/// <summary>
/// Notes on how to properly apply the license.
/// </summary>
public string Implementation { get; protected set; }
/// <summary>
/// Set of codes for what is required under the terms of the license. For example, "include-copyright"
/// </summary>
public IReadOnlyCollection<string> Required { get; protected set; }
/// <summary>
/// Set of codes for what is permitted under the terms of the license. For example, "commerical-use"
/// </summary>
public IReadOnlyCollection<string> Permitted { get; protected set; }
/// <summary>
/// Set of codes for what is forbidden under the terms of the license. For example, "no-liability"
/// </summary>
public IReadOnlyCollection<string> Forbidden { get; protected set; }
/// <summary>
/// The text of the license
/// </summary>
public string Body { get; protected set; }
internal override string DebuggerDisplay
{
get
{
return String.Format(CultureInfo.InvariantCulture, "{0} Category: {1}", base.DebuggerDisplay, Category);
}
}
}
}