PepperDashCore/Pepperdash Core/Pepperdash Core/XSigUtility/XSigTokenStreamWriter.cs

using System;
using System.Linq;
using System.Collections.Generic;
using Crestron.SimplSharp.CrestronIO;
using PepperDash.Core.Intersystem.Serialization;
using PepperDash.Core.Intersystem.Tokens;

namespace PepperDash.Core.Intersystem
{
    /// <summary>
    /// XSigToken stream writer.
    /// </summary>
    public sealed class XSigTokenStreamWriter : IDisposable
    {
        private readonly Stream _stream;
        private readonly bool _leaveOpen;

        /// <inheritdoc />
        /// <summary>
        /// XSigToken stream writer constructor.
        /// </summary>
        /// <param name="stream">Input stream to write to.</param>
        /// <exception cref="T:System.ArgumentNullException">Stream is null.</exception>
        /// <exception cref="T:System.ArgumentException">Stream cannot be written to.</exception>
        public XSigTokenStreamWriter(Stream stream)
            : this(stream, false) { }

        /// <summary>
        /// XSigToken stream writer constructor.
        /// </summary>
        /// <param name="stream">Input stream to write to.</param>
        /// <param name="leaveOpen">Determines whether to leave the stream open or not.</param>
        /// <exception cref="ArgumentNullException">Stream is null.</exception>
        /// <exception cref="ArgumentException">Stream cannot be written to.</exception>
        public XSigTokenStreamWriter(Stream stream, bool leaveOpen)
        {
            if (stream == null)
                throw new ArgumentNullException("stream");
            if (!stream.CanWrite)
                throw new ArgumentException("The specified stream cannot be written to.");

            _stream = stream;
            _leaveOpen = leaveOpen;
        }

        /// <summary>
        /// Write XSig data gathered from an IXSigStateResolver to the stream.
        /// </summary>
        /// <param name="xSigSerialization">IXSigStateResolver object.</param>
        public void WriteXSigData(IXSigSerialization xSigSerialization)
        {
            WriteXSigData(xSigSerialization, 0);
        }

        /// <summary>
        /// Write XSig data gathered from an IXSigStateResolver to the stream.
        /// </summary>
        /// <param name="xSigSerialization">IXSigStateResolver object.</param>
        /// <param name="offset">Index offset for each XSigToken.</param>
        public void WriteXSigData(IXSigSerialization xSigSerialization, int offset)
        {
            if (xSigSerialization == null)
                throw new ArgumentNullException("xSigSerialization");

            var tokens = xSigSerialization.Serialize();
            WriteXSigData(tokens, offset);
        }

        /// <summary>
        /// Write XSigToken to the stream.
        /// </summary>
        /// <param name="token">XSigToken object.</param>
        public void WriteXSigData(XSigToken token)
        {
            WriteXSigData(token, 0);
        }

        /// <summary>
        /// Write XSigToken to the stream.
        /// </summary>
        /// <param name="token">XSigToken object.</param>
        /// <param name="offset">Index offset for each XSigToken.</param>
        public void WriteXSigData(XSigToken token, int offset)
        {
            WriteXSigData(new[] { token }, offset);
        }

        /// <summary>
        /// Writes an array of XSigTokens to the stream.
        /// </summary>
        /// <param name="tokens">XSigToken objects.</param>
        public void WriteXSigData(XSigToken[] tokens)
        {
            WriteXSigData(tokens.AsEnumerable());
        }

        /// <summary>
        /// Write an enumerable collection of XSigTokens to the stream.
        /// </summary>
        /// <param name="tokens">XSigToken objects.</param>
        public void WriteXSigData(IEnumerable<XSigToken> tokens)
        {
            WriteXSigData(tokens, 0);
        }

        /// <summary>
        /// Write an enumerable collection of XSigTokens to the stream.
        /// </summary>
        /// <param name="tokens">XSigToken objects.</param>
        /// <param name="offset">Index offset for each XSigToken.</param>
        public void WriteXSigData(IEnumerable<XSigToken> tokens, int offset)
        {
            if (offset < 0)
                throw new ArgumentOutOfRangeException("offset", "Offset must be greater than or equal to 0.");

            if (tokens != null)
            {
                foreach (var token in tokens)
                {
                    if (token == null) continue;
                    var bytes = token.GetTokenWithOffset(offset).GetBytes();
                    _stream.Write(bytes, 0, bytes.Length);
                }
            }
        }

        /// <summary>
        /// Disposes of the internal stream if specified to not leave open.
        /// </summary>
        public void Dispose()
        {
            if (!_leaveOpen)
                _stream.Dispose();
        }
    }
}