PackageReference.cs

Go to the documentation of this file.

// Copyright (c) 2014 Silicon Studio Corp. (http://siliconstudio.co.jp)
// This file is distributed under GPL v3. See LICENSE.md for details.
using System;
using SiliconStudio.Core;
using SiliconStudio.Core.IO;

namespace SiliconStudio.Assets
{
    /// <summary>
    /// A reference to a local package loaded into the same <see cref="PackageSession"/>.
    /// </summary>
    [DataContract("PackageReference")]
    public sealed class PackageReference
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="PackageReference"/> class.
        /// </summary>
        public PackageReference()
        {
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="PackageReference"/> class.
        /// </summary>
        /// <param name="id">The identifier.</param>
        /// <param name="location">The location.</param>
        public PackageReference(Guid id, UFile location)
        {
            Id = id;
            Location = location;
        }

        /// <summary>
        /// Gets or sets the identifier of the package.
        /// </summary>
        /// <value>The identifier.</value>
        public Guid Id { get; set; }

        /// <summary>
        /// Gets or sets the location of the package description file on the disk, relative to the package that is holding
        /// this reference.
        /// </summary>
        /// <value>The location.</value>
        public UFile Location { get; set; }

        /// <summary>
        /// Clones this instance.
        /// </summary>
        /// <returns>PackageReference.</returns>
        public PackageReference Clone()
        {
            return new PackageReference(Id, Location);
        }

        /// <summary>
        /// Tries to parse a package reference in the format {guid:location}.
        /// </summary>
        /// <param name="packageReferenceAsText">The package reference as text.</param>
        /// <param name="packageReference">The package reference.</param>
        /// <returns><c>true</c> if the package reference is a valid reference, <c>false</c> otherwise.</returns>
        public static bool TryParse(string packageReferenceAsText, out PackageReference packageReference)
        {
            Guid id;
            UFile location;
            packageReference = null;
            if (AssetReference.TryParse(packageReferenceAsText, out id, out location))
            {
                packageReference = new PackageReference(id, location);
                return true;
            }
            return false;
        }

        /// <summary>
        /// Performs an implicit conversion from <see cref="Package"/> to <see cref="PackageReference"/>.
        /// </summary>
        /// <param name="package">The package.</param>
        /// <returns>The result of the conversion.</returns>
        public static implicit operator PackageReference(Package package)
        {
            return new PackageReference(package.Id, package.FullPath);
        }

        public override string ToString()
        {
            // WARNING: This should not be modified as it is used for serializing
            return string.Format("{0}:{1}", Id, Location);
        }
    }
}