/* ****************************************************************************
 *
 * Copyright (c) Microsoft Corporation. 
 *
 * This source code is subject to terms and conditions of the Microsoft Public License. A 
 * copy of the license can be found in the License.html file at the root of this distribution. If 
 * you cannot locate the  Microsoft Public License, please send an email to 
 * ironruby@microsoft.com. By using this source code in any fashion, you are agreeing to be bound 
 * by the terms of the Microsoft Public License.
 *
 * You must not remove this notice, or any other, from this software.
 *
 *
 * ***************************************************************************/

using System;
using System.IO;

namespace Microsoft.Scripting {
    /// <summary>
    /// Provides a factory to create streams over one source of binary content.  
    /// 
    /// StreamContentProvider's are used when opening a file of an unknown encoding.  The
    /// StreamContentProvider will be wrapped in a TextContentProvider provided by the language
    /// which can support a language specific way of interpreting the binary data into text. 
    /// 
    /// For example some languages allow a marker at the beginning of the file which specifies
    /// the encoding of the rest of the file.
    /// </summary>
    [Serializable]
    public abstract class StreamContentProvider {
        /// <summary>
        /// Creates a new Stream which is backed by the content the StreamContentProvider was created for.
        /// 
        /// For example if the StreamContentProvider was backing a file then GetStream re-opens the file and returns
        /// the new stream.
        /// 
        /// This method may be called multiple times.  For example once to compile the code and again to get
        /// the source code to display error messages.
        /// </summary>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate")]
        public abstract Stream GetStream();
    }
}
