ByteCollection.cs

using System;

using System.Collections;

namespace Be.Windows.Forms
{
	/// <summary>
	/// Represents a collection of bytes.
	/// </summary>
	public class ByteCollection : CollectionBase
	{
		/// <summary>
		/// Initializes a new instance of ByteCollection class.
		/// </summary>
		public ByteCollection()
		{}

		/// <summary>
		/// Initializes a new instance of ByteCollection class.
		/// </summary>
		/// <param name="bs">an array of bytes to add to collection</param>
		public ByteCollection(byte[] bs)
		{ AddRange(bs); }

		/// <summary>
		/// Gets or sets the value of a byte
		/// </summary>
		public byte this[int index]
		{
			get { return (byte)List[index]; }
			set { List[index] = value; }
		}

		/// <summary>
		/// Adds a byte into the collection.
		/// </summary>
		/// <param name="b">the byte to add</param>
		public void Add(byte b)
		{ List.Add(b); }

		/// <summary>
		/// Adds a range of bytes to the collection.
		/// </summary>
		/// <param name="bs">the bytes to add</param>
		public void AddRange(byte[] bs)
		{ InnerList.AddRange(bs); }

		/// <summary>
		/// Removes a byte from the collection.
		/// </summary>
		/// <param name="b">the byte to remove</param>
		public void Remove(byte b)
		{ List.Remove(b); }

		/// <summary>
		/// Removes a range of bytes from the collection.
		/// </summary>
		/// <param name="index">the index of the start byte</param>
		/// <param name="count">the count of the bytes to remove</param>
		public void RemoveRange(int index, int count)
		{ InnerList.RemoveRange(index, count); }

		/// <summary>
		/// Inserts a range of bytes to the collection.
		/// </summary>
		/// <param name="index">the index of start byte</param>
		/// <param name="bs">an array of bytes to insert</param>
		public void InsertRange(int index, byte[] bs)
		{ InnerList.InsertRange(index, bs); }

		/// <summary>
		/// Gets all bytes in the array
		/// </summary>
		/// <returns>an array of bytes.</returns>
		public byte[] GetBytes()
		{
			byte[] bytes = new byte[Count];
			InnerList.CopyTo(0, bytes, 0, bytes.Length);
			return bytes;
		}

		/// <summary>
		/// Inserts a byte to the collection.
		/// </summary>
		/// <param name="index">the index</param>
		/// <param name="b">a byte to insert</param>
		public void Insert(int index, byte b)
		{
			InnerList.Insert(index, b);
		}

		/// <summary>
		/// Returns the index of the given byte.
		/// </summary>
		public int IndexOf(byte b)
		{
			return InnerList.IndexOf(b);
		}

		/// <summary>
		/// Returns true, if the byte exists in the collection.
		/// </summary>
		public bool Contains(byte b)
		{
			return InnerList.Contains(b);
		}

		/// <summary>
		/// Copies the content of the collection into the given array.
		/// </summary>
		public void CopyTo(byte[] bs, int index)
		{
			InnerList.CopyTo(bs, index);
		}

		/// <summary>
		/// Copies the content of the collection into an array.
		/// </summary>
		/// <returns>the array containing all bytes.</returns>
		public byte[] ToArray()
		{
			byte[] data = new byte[this.Count];
			this.CopyTo(data, 0);
			return data;
		}

	}
}