From 8776d1afa6dce054f3bc7cb421c86f3e2fe06ab3 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Sun, 10 Dec 2017 18:05:18 -0500
Subject: adjust reflection API to correctly reflect what it does (#410)

---
 src/SMAPI/IReflectionHelper.cs | 55 ++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 53 insertions(+), 2 deletions(-)

(limited to 'src/SMAPI/IReflectionHelper.cs')

diff --git a/src/SMAPI/IReflectionHelper.cs b/src/SMAPI/IReflectionHelper.cs
index fb2c7861..fcebae42 100644
--- a/src/SMAPI/IReflectionHelper.cs
+++ b/src/SMAPI/IReflectionHelper.cs
@@ -1,18 +1,62 @@
-using System;
+using System;
 
 namespace StardewModdingAPI
 {
-    /// <summary>Provides an API for accessing private game code.</summary>
+    /// <summary>Provides an API for accessing inaccessible code.</summary>
     public interface IReflectionHelper : IModLinked
     {
         /*********
         ** Public methods
         *********/
+        /// <summary>Get an instance field.</summary>
+        /// <typeparam name="TValue">The field type.</typeparam>
+        /// <param name="obj">The object which has the field.</param>
+        /// <param name="name">The field name.</param>
+        /// <param name="required">Whether to throw an exception if the field is not found.</param>
+        IReflectedField<TValue> GetField<TValue>(object obj, string name, bool required = true);
+
+        /// <summary>Get a static field.</summary>
+        /// <typeparam name="TValue">The field type.</typeparam>
+        /// <param name="type">The type which has the field.</param>
+        /// <param name="name">The field name.</param>
+        /// <param name="required">Whether to throw an exception if the field is not found.</param>
+        IReflectedField<TValue> GetField<TValue>(Type type, string name, bool required = true);
+
+        /// <summary>Get an instance property.</summary>
+        /// <typeparam name="TValue">The property type.</typeparam>
+        /// <param name="obj">The object which has the property.</param>
+        /// <param name="name">The property name.</param>
+        /// <param name="required">Whether to throw an exception if the property is not found.</param>
+        IReflectedProperty<TValue> GetProperty<TValue>(object obj, string name, bool required = true);
+
+        /// <summary>Get a static property.</summary>
+        /// <typeparam name="TValue">The property type.</typeparam>
+        /// <param name="type">The type which has the property.</param>
+        /// <param name="name">The property name.</param>
+        /// <param name="required">Whether to throw an exception if the property is not found.</param>
+        IReflectedProperty<TValue> GetProperty<TValue>(Type type, string name, bool required = true);
+
+        /// <summary>Get an instance method.</summary>
+        /// <param name="obj">The object which has the method.</param>
+        /// <param name="name">The field name.</param>
+        /// <param name="required">Whether to throw an exception if the field is not found.</param>
+        IReflectedMethod GetMethod(object obj, string name, bool required = true);
+
+        /// <summary>Get a static method.</summary>
+        /// <param name="type">The type which has the method.</param>
+        /// <param name="name">The field name.</param>
+        /// <param name="required">Whether to throw an exception if the field is not found.</param>
+        IReflectedMethod GetMethod(Type type, string name, bool required = true);
+
+        /*****
+        ** Obsolete
+        *****/
         /// <summary>Get a private instance field.</summary>
         /// <typeparam name="TValue">The field type.</typeparam>
         /// <param name="obj">The object which has the field.</param>
         /// <param name="name">The field name.</param>
         /// <param name="required">Whether to throw an exception if the private field is not found.</param>
+        [Obsolete("Use " + nameof(IReflectionHelper) + "." + nameof(IReflectionHelper.GetField) + " instead")]
         IPrivateField<TValue> GetPrivateField<TValue>(object obj, string name, bool required = true);
 
         /// <summary>Get a private static field.</summary>
@@ -20,6 +64,7 @@ namespace StardewModdingAPI
         /// <param name="type">The type which has the field.</param>
         /// <param name="name">The field name.</param>
         /// <param name="required">Whether to throw an exception if the private field is not found.</param>
+        [Obsolete("Use " + nameof(IReflectionHelper) + "." + nameof(IReflectionHelper.GetField) + " instead")]
         IPrivateField<TValue> GetPrivateField<TValue>(Type type, string name, bool required = true);
 
         /// <summary>Get a private instance property.</summary>
@@ -27,6 +72,7 @@ namespace StardewModdingAPI
         /// <param name="obj">The object which has the property.</param>
         /// <param name="name">The property name.</param>
         /// <param name="required">Whether to throw an exception if the private property is not found.</param>
+        [Obsolete("Use " + nameof(IReflectionHelper) + "." + nameof(IReflectionHelper.GetProperty) + " instead")]
         IPrivateProperty<TValue> GetPrivateProperty<TValue>(object obj, string name, bool required = true);
 
         /// <summary>Get a private static property.</summary>
@@ -34,6 +80,7 @@ namespace StardewModdingAPI
         /// <param name="type">The type which has the property.</param>
         /// <param name="name">The property name.</param>
         /// <param name="required">Whether to throw an exception if the private property is not found.</param>
+        [Obsolete("Use " + nameof(IReflectionHelper) + "." + nameof(IReflectionHelper.GetProperty) + " instead")]
         IPrivateProperty<TValue> GetPrivateProperty<TValue>(Type type, string name, bool required = true);
 
         /// <summary>Get the value of a private instance field.</summary>
@@ -42,6 +89,7 @@ namespace StardewModdingAPI
         /// <param name="name">The field name.</param>
         /// <param name="required">Whether to throw an exception if the private field is not found.</param>
         /// <remarks>This is a shortcut for <see cref="GetPrivateField{TValue}(object,string,bool)"/> followed by <see cref="IPrivateField{TValue}.GetValue"/>.</remarks>
+        [Obsolete("Use " + nameof(IReflectionHelper) + "." + nameof(IReflectionHelper.GetField) + " or " + nameof(IReflectionHelper) + "." + nameof(IReflectionHelper.GetProperty) + " instead")]
         TValue GetPrivateValue<TValue>(object obj, string name, bool required = true);
 
         /// <summary>Get the value of a private static field.</summary>
@@ -50,18 +98,21 @@ namespace StardewModdingAPI
         /// <param name="name">The field name.</param>
         /// <param name="required">Whether to throw an exception if the private field is not found.</param>
         /// <remarks>This is a shortcut for <see cref="GetPrivateField{TValue}(Type,string,bool)"/> followed by <see cref="IPrivateField{TValue}.GetValue"/>.</remarks>
+        [Obsolete("Use " + nameof(IReflectionHelper) + "." + nameof(IReflectionHelper.GetField) + " or " + nameof(IReflectionHelper) + "." + nameof(IReflectionHelper.GetProperty) + " instead")]
         TValue GetPrivateValue<TValue>(Type type, string name, bool required = true);
 
         /// <summary>Get a private instance method.</summary>
         /// <param name="obj">The object which has the method.</param>
         /// <param name="name">The field name.</param>
         /// <param name="required">Whether to throw an exception if the private field is not found.</param>
+        [Obsolete("Use " + nameof(IReflectionHelper) + "." + nameof(IReflectionHelper.GetMethod) + " instead")]
         IPrivateMethod GetPrivateMethod(object obj, string name, bool required = true);
 
         /// <summary>Get a private static method.</summary>
         /// <param name="type">The type which has the method.</param>
         /// <param name="name">The field name.</param>
         /// <param name="required">Whether to throw an exception if the private field is not found.</param>
+        [Obsolete("Use " + nameof(IReflectionHelper) + "." + nameof(IReflectionHelper.GetMethod) + " instead")]
         IPrivateMethod GetPrivateMethod(Type type, string name, bool required = true);
     }
 }
-- 
cgit