File: SubstitutionValueContainer.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

/// +------------------------------------------------------------------------------------------------------------------------------+
/// ¦                                                   TERMS OF USE: MIT License                                                  ¦
/// +------------------------------------------------------------------------------------------------------------------------------¦
/// ¦Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation    ¦
/// ¦files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy,    ¦
/// ¦modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software¦
/// ¦is furnished to do so, subject to the following conditions:                                                                   ¦
/// ¦                                                                                                                              ¦
/// ¦The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.¦
/// ¦                                                                                                                              ¦
/// ¦THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE          ¦
/// ¦WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR         ¦
/// ¦COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,   ¦
/// ¦ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                         ¦
/// +------------------------------------------------------------------------------------------------------------------------------+

namespace CoDocker
{
    /// +=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=
    /// +=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=
    /// <summary>
    /// A class to hold a set of substituion values etc. Makes it easier to pass
    /// around as a set.
    /// </summary>
    /// <history>
    ///    20 May 11  Cynic - Started
    /// </history>
    public class SubstitutionValueContainer 
    {
        private InputFileTypeEnum inputFileType = InputFileTypeEnum.INPUTFILETYPE_UNKNOWN;
        private string title = "";
        private string sourceFilePathAndName = null;
        private string htmlFilePathAndName = null;

        /// +=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=
        /// <summary>
        /// Constructor
        /// </summary>
        /// <param name="inputFileTypeIn">the input file type</param>
        /// <param name="htmlFilePathAndNameIn">html output file name</param>
        /// <param name="fsourceFilePathAndNameIn">the full name and path of the file</param>
        /// <history>
        ///    20 May 11  Cynic - Started
        /// </history>
        public SubstitutionValueContainer(InputFileTypeEnum inputFileTypeIn, string htmlFilePathAndNameIn, string sourceFilePathAndNameIn)
        {
            HTMLFilePathAndName = htmlFilePathAndNameIn;
            SourceFilePathAndName = sourceFilePathAndNameIn;
            InputFileType = inputFileTypeIn;
        }

        /// +=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=
        /// <summary>
        /// Constructor
        /// </summary>
        /// <param name="inputFileTypeIn">the input file type</param>
        /// <param name="htmlFilePathAndNameIn">html output file name</param>
        /// <param name="fsourceFilePathAndNameIn">the full name and path of the file</param>
        /// <history>
        ///    20 May 11  Cynic - Started
        /// </history>
        public SubstitutionValueContainer(InputFileTypeEnum inputFileTypeIn, File_Base fileBaseIn)
        {
            if (fileBaseIn != null)
            {
                HTMLFilePathAndName = fileBaseIn.HTMLFilePathAndName;
                SourceFilePathAndName = fileBaseIn.SourceFilePathAndName;
            }
            InputFileType = inputFileTypeIn;
        }

        /// +=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=
        /// <summary>
        /// Gets/sets the current title, will never get or set null
        /// </summary>
        /// <history>
        ///    20 May 11  Cynic - Started
        /// </history>
        public string Title
        {
            get
            {
                if (title == null) title = "";
                return title;
            }
            set
            {
                title = value;
                if (title == null) title = "";
            }
        }
       
        /// +=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=
        /// <summary>
        /// Gets/sets the current source file path and name, will never get or set null
        /// </summary>
        /// <history>
        ///    20 May 11  Cynic - Started
        /// </history>
        public string SourceFilePathAndName
        {
            get
            {
                if (sourceFilePathAndName == null) sourceFilePathAndName = "";
                return sourceFilePathAndName;
            }
            set
            {
                sourceFilePathAndName = value;
                if (sourceFilePathAndName == null) sourceFilePathAndName = "";
            }
        }

        /// +=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=
        /// <summary>
        /// Gets/sets the output html file path and name, will never get or set null
        /// </summary>
        /// <history>
        ///    20 May 11  Cynic - Started
        /// </history>
        public string HTMLFilePathAndName
        {
            get
            {
                if (htmlFilePathAndName == null) htmlFilePathAndName = "";
                return htmlFilePathAndName;
            }
            set
            {
                htmlFilePathAndName = value;
                if (htmlFilePathAndName == null) htmlFilePathAndName = "";
            }
        }

        /// +=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=
        /// <summary>
        /// Gets/sets the input file type
        /// </summary>
        /// <history>
        ///    23 May 11  Cynic - Started
        /// </history>
        public InputFileTypeEnum InputFileType
        {
            get
            {
                return inputFileType;
            }
            set
            {
                inputFileType = value;
            }
        }
    }
}