[generator] Use [Obsolete(error:true)] for *InterfaceConsts classes (#490)

jpobst · jonpryor · commit 2600d41a3a09 · 2019-09-06T12:03:18.000-04:00
Context: #436 The `*InterfaceConsts` classes we've been generating for ages have been marked as `[Obsolete]` for at least 3 years: [Obsolete ("Use the 'MyInterface' type. This type will be removed in a future release.")] public abstract class MyInterfaceConsts : MyInterface { } It's time to tighten the screws a little bit and make this an error: [Obsolete ("Use the 'MyInterface' type. This type will be removed in a future release.", error: true)] public abstract class MyInterfaceConsts : MyInterface { }
diff --git a/tools/generator/Java.Interop.Tools.Generator.CodeGeneration/CodeGenerator.cs b/tools/generator/Java.Interop.Tools.Generator.CodeGeneration/CodeGenerator.cs
@@ -747,7 +747,7 @@ public void WriteInterfaceImplementedMembersAlternative (InterfaceGen @interface
 
 				if (!@interface.HasManagedName) {
 					writer.WriteLine ("{0}[Register (\"{1}\"{2}, DoNotGenerateAcw=true)]", indent, @interface.RawJniName, @interface.AdditionalAttributeString ());
-					writer.WriteLine ("{0}[global::System.Obsolete (\"Use the '{1}' type. This type will be removed in a future release.\")]", indent, name);
+					writer.WriteLine ("{0}[global::System.Obsolete (\"Use the '{1}' type. This type will be removed in a future release.\", error: true)]", indent, name);
 					writer.WriteLine ("{0}public abstract class {1}Consts : {1} {{", indent, name);
 					writer.WriteLine ();
 					writer.WriteLine ("{0}\tprivate {1}Consts ()", indent, name);
diff --git a/tools/generator/Tests/Unit-Tests/CodeGeneratorExpectedResults/JavaInterop1/WriteInterface.txt b/tools/generator/Tests/Unit-Tests/CodeGeneratorExpectedResults/JavaInterop1/WriteInterface.txt
@@ -20,7 +20,7 @@ public abstract class MyInterface : Java.Lang.Object {
 }
 
 [Register ("java/code/IMyInterface", DoNotGenerateAcw=true)]
-[global::System.Obsolete ("Use the 'MyInterface' type. This type will be removed in a future release.")]
+[global::System.Obsolete ("Use the 'MyInterface' type. This type will be removed in a future release.", error: true)]
 public abstract class MyInterfaceConsts : MyInterface {
 
 	private MyInterfaceConsts ()
diff --git a/tools/generator/Tests/Unit-Tests/CodeGeneratorExpectedResults/JavaInterop1/WriteStaticInterfaceMethod.txt b/tools/generator/Tests/Unit-Tests/CodeGeneratorExpectedResults/JavaInterop1/WriteStaticInterfaceMethod.txt
@@ -20,7 +20,7 @@ public abstract class MyInterface : Java.Lang.Object {
 }
 
 [Register ("java/code/IMyInterface", DoNotGenerateAcw=true)]
-[global::System.Obsolete ("Use the 'MyInterface' type. This type will be removed in a future release.")]
+[global::System.Obsolete ("Use the 'MyInterface' type. This type will be removed in a future release.", error: true)]
 public abstract class MyInterfaceConsts : MyInterface {
 
 	private MyInterfaceConsts ()
diff --git a/tools/generator/Tests/Unit-Tests/CodeGeneratorExpectedResults/XAJavaInterop1/WriteInterface.txt b/tools/generator/Tests/Unit-Tests/CodeGeneratorExpectedResults/XAJavaInterop1/WriteInterface.txt
@@ -20,7 +20,7 @@ public abstract class MyInterface : Java.Lang.Object {
 }
 
 [Register ("java/code/IMyInterface", DoNotGenerateAcw=true)]
-[global::System.Obsolete ("Use the 'MyInterface' type. This type will be removed in a future release.")]
+[global::System.Obsolete ("Use the 'MyInterface' type. This type will be removed in a future release.", error: true)]
 public abstract class MyInterfaceConsts : MyInterface {
 
 	private MyInterfaceConsts ()
diff --git a/tools/generator/Tests/Unit-Tests/CodeGeneratorExpectedResults/XAJavaInterop1/WriteStaticInterfaceMethod.txt b/tools/generator/Tests/Unit-Tests/CodeGeneratorExpectedResults/XAJavaInterop1/WriteStaticInterfaceMethod.txt
@@ -20,7 +20,7 @@ public abstract class MyInterface : Java.Lang.Object {
 }
 
 [Register ("java/code/IMyInterface", DoNotGenerateAcw=true)]
-[global::System.Obsolete ("Use the 'MyInterface' type. This type will be removed in a future release.")]
+[global::System.Obsolete ("Use the 'MyInterface' type. This type will be removed in a future release.", error: true)]
 public abstract class MyInterfaceConsts : MyInterface {
 
 	private MyInterfaceConsts ()
diff --git a/tools/generator/Tests/Unit-Tests/CodeGeneratorExpectedResults/XamarinAndroid/WriteInterface.txt b/tools/generator/Tests/Unit-Tests/CodeGeneratorExpectedResults/XamarinAndroid/WriteInterface.txt
@@ -22,7 +22,7 @@ public abstract class MyInterface : Java.Lang.Object {
 }
 
 [Register ("java/code/IMyInterface", DoNotGenerateAcw=true)]
-[global::System.Obsolete ("Use the 'MyInterface' type. This type will be removed in a future release.")]
+[global::System.Obsolete ("Use the 'MyInterface' type. This type will be removed in a future release.", error: true)]
 public abstract class MyInterfaceConsts : MyInterface {
 
 	private MyInterfaceConsts ()
diff --git a/tools/generator/Tests/expected.ji/TestInterface/Test.ME.ITestInterface.cs b/tools/generator/Tests/expected.ji/TestInterface/Test.ME.ITestInterface.cs
@@ -32,7 +32,7 @@ internal TestInterface ()
 	}
 
 	[Register ("test/me/TestInterface", DoNotGenerateAcw=true)]
-	[global::System.Obsolete ("Use the 'TestInterface' type. This type will be removed in a future release.")]
+	[global::System.Obsolete ("Use the 'TestInterface' type. This type will be removed in a future release.", error: true)]
 	public abstract class TestInterfaceConsts : TestInterface {
 
 		private TestInterfaceConsts ()
diff --git a/tools/generator/Tests/expected/TestInterface/Test.ME.ITestInterface.cs b/tools/generator/Tests/expected/TestInterface/Test.ME.ITestInterface.cs
@@ -32,7 +32,7 @@ internal TestInterface ()
 	}
 
 	[Register ("test/me/TestInterface", DoNotGenerateAcw=true)]
-	[global::System.Obsolete ("Use the 'TestInterface' type. This type will be removed in a future release.")]
+	[global::System.Obsolete ("Use the 'TestInterface' type. This type will be removed in a future release.", error: true)]
 	public abstract class TestInterfaceConsts : TestInterface {
 
 		private TestInterfaceConsts ()

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ public abstract class MyInterface : Java.Lang.Object {`
`20`	`20`	`}`
`21`	`21`
`22`	`22`	`[Register ("java/code/IMyInterface", DoNotGenerateAcw=true)]`
`23`		`-[global::System.Obsolete ("Use the 'MyInterface' type. This type will be removed in a future release.")]`
	`23`	`+[global::System.Obsolete ("Use the 'MyInterface' type. This type will be removed in a future release.", error: true)]`
`24`	`24`	`public abstract class MyInterfaceConsts : MyInterface {`
`25`	`25`
`26`	`26`	`private MyInterfaceConsts ()`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ public abstract class MyInterface : Java.Lang.Object {`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`[Register ("java/code/IMyInterface", DoNotGenerateAcw=true)]`
`25`		`-[global::System.Obsolete ("Use the 'MyInterface' type. This type will be removed in a future release.")]`
	`25`	`+[global::System.Obsolete ("Use the 'MyInterface' type. This type will be removed in a future release.", error: true)]`
`26`	`26`	`public abstract class MyInterfaceConsts : MyInterface {`
`27`	`27`
`28`	`28`	`private MyInterfaceConsts ()`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ internal TestInterface ()`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`[Register ("test/me/TestInterface", DoNotGenerateAcw=true)]`
`35`		`- [global::System.Obsolete ("Use the 'TestInterface' type. This type will be removed in a future release.")]`
	`35`	`+ [global::System.Obsolete ("Use the 'TestInterface' type. This type will be removed in a future release.", error: true)]`
`36`	`36`	`public abstract class TestInterfaceConsts : TestInterface {`
`37`	`37`
`38`	`38`	`private TestInterfaceConsts ()`