/JustAProgrammer.ADPR/Log4Net/IADPRLog.cs

https://github.com/zippy1981/AppDomainPoshRunner
C# | 180 lines | 20 code | 9 blank | 151 comment | 0 complexity | 98ca12e80cf2b433124f508e661eb2eb MD5 | raw file
  1. using System;
  2. using System.Collections.Generic;
  3. using System.Linq;
  4. using System.Text;
  5. using log4net;
  6. using log4net.Core;
  7. namespace JustAProgrammer.ADPR.Log4Net
  8. {
  9. internal interface IADPRLog :ILog
  10. {
  11. /// <summary>
  12. /// Checks if this logger is enabled for the <see cref="Level.Verbose"/> level.
  13. /// </summary>
  14. /// <value>
  15. /// <c>true</c> if this logger is enabled for <see cref="Level.Verbose"/> events, <c>false</c> otherwise.
  16. /// </value>
  17. /// <remarks>
  18. /// For more information see <see cref="ILog.IsDebugEnabled"/>.
  19. /// </remarks>
  20. /// <seealso cref="M:Verbose(object)"/>
  21. /// <seealso cref="M:VerboseFormat(IFormatProvider, string, object[])"/>
  22. /// <seealso cref="ILog.IsDebugEnabled"/>
  23. bool IsVerboseEnabled { get; }
  24. /// <overloads>Log a message object with the <see cref="Level.Verbose"/> level.</overloads>
  25. /// <summary>
  26. /// Logs a message object with the <see cref="Level.Verbose"/> level.
  27. /// </summary>
  28. /// <remarks>
  29. /// <para>
  30. /// This method first checks if this logger is <c>VERBOSE</c>
  31. /// enabled by comparing the level of this logger with the
  32. /// <see cref="Level.Verbose"/> level. If this logger is
  33. /// <c>VERBOSE</c> enabled, then it converts the message object
  34. /// (passed as parameter) to a string by invoking the appropriate
  35. /// <see cref="log4net.ObjectRenderer.IObjectRenderer"/>. It then
  36. /// proceeds to call all the registered appenders in this logger
  37. /// and also higher in the hierarchy depending on the value of the
  38. /// additivity flag.
  39. /// </para>
  40. /// <para><b>WARNING</b> Note that passing an <see cref="Exception"/>
  41. /// to this method will print the name of the <see cref="Exception"/>
  42. /// but no stack trace. To print a stack trace use the
  43. /// <see cref="M:Verbose(object,Exception)"/> form instead.
  44. /// </para>
  45. /// </remarks>
  46. /// <param name="message">The message object to log.</param>
  47. /// <seealso cref="M:Verbose(object,Exception)"/>
  48. /// <seealso cref="IsVerboseEnabled"/>
  49. void Verbose(object message);
  50. /// <summary>
  51. /// Logs a message object with the <c>VERBOSE</c> level including
  52. /// the stack trace of the <see cref="Exception"/> passed
  53. /// as a parameter.
  54. /// </summary>
  55. /// <param name="message">The message object to log.</param>
  56. /// <param name="exception">The exception to log, including its stack trace.</param>
  57. /// <remarks>
  58. /// <para>
  59. /// See the <see cref="M:Verbose(object)"/> form for more detailed information.
  60. /// </para>
  61. /// </remarks>
  62. /// <seealso cref="M:Verbose(object)"/>
  63. /// <seealso cref="IsVerboseEnabled"/>
  64. void Verbose(object message, Exception exception);
  65. /// <overloads>Log a formatted message string with the <see cref="Level.Verbose"/> level.</overloads>
  66. /// <summary>
  67. /// Logs a formatted message string with the <see cref="Level.Verbose"/> level.
  68. /// </summary>
  69. /// <param name="format">A String containing zero or more format items</param>
  70. /// <param name="args">An Object array containing zero or more objects to format</param>
  71. /// <remarks>
  72. /// <para>
  73. /// The message is formatted using the <c>String.Format</c> method. See
  74. /// <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  75. /// of the formatting.
  76. /// </para>
  77. /// <para>
  78. /// This method does not take an <see cref="Exception"/> object to include in the
  79. /// log event. To pass an <see cref="Exception"/> use one of the <see cref="M:Verbose(object)"/>
  80. /// methods instead.
  81. /// </para>
  82. /// </remarks>
  83. /// <seealso cref="M:Verbose(object,Exception)"/>
  84. /// <seealso cref="IsVerboseEnabled"/>
  85. void VerboseFormat(string format, params object[] args);
  86. /// <summary>
  87. /// Logs a formatted message string with the <see cref="Level.Verbose"/> level.
  88. /// </summary>
  89. /// <param name="format">A String containing zero or more format items</param>
  90. /// <param name="arg0">An Object to format</param>
  91. /// <remarks>
  92. /// <para>
  93. /// The message is formatted using the <c>String.Format</c> method. See
  94. /// <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  95. /// of the formatting.
  96. /// </para>
  97. /// <para>
  98. /// This method does not take an <see cref="Exception"/> object to include in the
  99. /// log event. To pass an <see cref="Exception"/> use one of the <see cref="M:Verbose(object,Exception)"/>
  100. /// methods instead.
  101. /// </para>
  102. /// </remarks>
  103. /// <seealso cref="M:Verbose(object)"/>
  104. /// <seealso cref="IsVerboseEnabled"/>
  105. void VerboseFormat(string format, object arg0);
  106. /// <summary>
  107. /// Logs a formatted message string with the <see cref="Level.Verbose"/> level.
  108. /// </summary>
  109. /// <param name="format">A String containing zero or more format items</param>
  110. /// <param name="arg0">An Object to format</param>
  111. /// <param name="arg1">An Object to format</param>
  112. /// <remarks>
  113. /// <para>
  114. /// The message is formatted using the <c>String.Format</c> method. See
  115. /// <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  116. /// of the formatting.
  117. /// </para>
  118. /// <para>
  119. /// This method does not take an <see cref="Exception"/> object to include in the
  120. /// log event. To pass an <see cref="Exception"/> use one of the <see cref="M:Verbose(object,Exception)"/>
  121. /// methods instead.
  122. /// </para>
  123. /// </remarks>
  124. /// <seealso cref="M:Verbose(object)"/>
  125. /// <seealso cref="IsVerboseEnabled"/>
  126. void VerboseFormat(string format, object arg0, object arg1);
  127. /// <summary>
  128. /// Logs a formatted message string with the <see cref="Level.Verbose"/> level.
  129. /// </summary>
  130. /// <param name="format">A String containing zero or more format items</param>
  131. /// <param name="arg0">An Object to format</param>
  132. /// <param name="arg1">An Object to format</param>
  133. /// <param name="arg2">An Object to format</param>
  134. /// <remarks>
  135. /// <para>
  136. /// The message is formatted using the <c>String.Format</c> method. See
  137. /// <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  138. /// of the formatting.
  139. /// </para>
  140. /// <para>
  141. /// This method does not take an <see cref="Exception"/> object to include in the
  142. /// log event. To pass an <see cref="Exception"/> use one of the <see cref="M:Verbose(object,Exception)"/>
  143. /// methods instead.
  144. /// </para>
  145. /// </remarks>
  146. /// <seealso cref="M:Verbose(object)"/>
  147. /// <seealso cref="IsVerboseEnabled"/>
  148. void VerboseFormat(string format, object arg0, object arg1, object arg2);
  149. /// <summary>
  150. /// Logs a formatted message string with the <see cref="Level.Verbose"/> level.
  151. /// </summary>
  152. /// <param name="provider">An <see cref="IFormatProvider"/> that supplies culture-specific formatting information</param>
  153. /// <param name="format">A String containing zero or more format items</param>
  154. /// <param name="args">An Object array containing zero or more objects to format</param>
  155. /// <remarks>
  156. /// <para>
  157. /// The message is formatted using the <c>String.Format</c> method. See
  158. /// <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  159. /// of the formatting.
  160. /// </para>
  161. /// <para>
  162. /// This method does not take an <see cref="Exception"/> object to include in the
  163. /// log event. To pass an <see cref="Exception"/> use one of the <see cref="M:Verbose(object)"/>
  164. /// methods instead.
  165. /// </para>
  166. /// </remarks>
  167. /// <seealso cref="M:Verbose(object,Exception)"/>
  168. /// <seealso cref="IsVerboseEnabled"/>
  169. void VerboseFormat(IFormatProvider provider, string format, params object[] args);
  170. }
  171. }