Skip to content

Commit b8bd979

Browse files
committed
[Java.Intreop] Rename Dispose methods
These have different signatures than the common dispose pattern methods, thus rename them to avoid confusion. Also rename other methods working with IJavaPeerable to be consistent. Catched by gendarme's https://github.com/spouliot/gendarme/wiki/Gendarme.Rules.Design.UseCorrectDisposeSignaturesRule(2.10)
1 parent 85fc91d commit b8bd979

File tree

7 files changed

+37
-37
lines changed

7 files changed

+37
-37
lines changed

gendarme-ignore.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ M: Java.Interop.JniType Java.Interop.JniLong::get_TypeRef()
5252
M: Java.Interop.JniType Java.Interop.JniPeerMembers::get_JniPeerType()
5353
M: Java.Interop.JniRuntime Java.Interop.JniRuntime::get_CurrentRuntime()
5454
M: System.Void Java.Interop.JniRuntime::RaisePendingException(System.Exception)
55-
M: System.Void Java.Interop.JniRuntime/JniValueManager::DisposeUnlessReferenced(Java.Interop.IJavaPeerable)
55+
M: System.Void Java.Interop.JniRuntime/JniValueManager::DisposePeerUnlessReferenced(Java.Interop.IJavaPeerable)
5656
M: System.Object Java.Interop.JniRuntime/JniValueManager::PeekValue(Java.Interop.JniObjectReference)
5757
M: System.Object Java.Interop.JniRuntime/JniValueManager::PeekBoxedObject(Java.Interop.JniObjectReference)
5858
M: Java.Interop.JniType Java.Interop.JniShort::get_TypeRef()
@@ -104,7 +104,7 @@ M: System.Void Java.Interop.JniObjectReference::Dispose(Java.Interop.JniObjectRe
104104
M: System.Exception Java.Interop.JniRuntime::GetExceptionForThrowable(Java.Interop.JniObjectReference&,Java.Interop.JniObjectReferenceOptions)
105105
M: System.Void Java.Interop.JniRuntime/JniObjectReferenceManager::DeleteGlobalReference(Java.Interop.JniObjectReference&)
106106
M: System.Void Java.Interop.JniRuntime/JniObjectReferenceManager::DeleteWeakGlobalReference(Java.Interop.JniObjectReference&)
107-
M: System.Void Java.Interop.JniRuntime/JniValueManager::Construct(Java.Interop.IJavaPeerable,Java.Interop.JniObjectReference&,Java.Interop.JniObjectReferenceOptions)
107+
M: System.Void Java.Interop.JniRuntime/JniValueManager::ConstructPeer(Java.Interop.IJavaPeerable,Java.Interop.JniObjectReference&,Java.Interop.JniObjectReferenceOptions)
108108
M: Java.Interop.IJavaPeerable Java.Interop.JniRuntime/JniValueManager::CreatePeer(Java.Interop.JniObjectReference&,Java.Interop.JniObjectReferenceOptions,System.Type)
109109
M: System.Object Java.Interop.JniRuntime/JniValueManager::CreateValue(Java.Interop.JniObjectReference&,Java.Interop.JniObjectReferenceOptions,System.Type)
110110
M: T Java.Interop.JniRuntime/JniValueManager::CreateValue(Java.Interop.JniObjectReference&,Java.Interop.JniObjectReferenceOptions,System.Type)

src/Java.Interop/Java.Interop/JavaException.cs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -84,12 +84,12 @@ public JavaException (ref JniObjectReference reference, JniObjectReferenceOption
8484

8585
protected void Construct (ref JniObjectReference reference, JniObjectReferenceOptions options)
8686
{
87-
JniEnvironment.Runtime.ValueManager.Construct (this, ref reference, options);
87+
JniEnvironment.Runtime.ValueManager.ConstructPeer (this, ref reference, options);
8888
}
8989

9090
~JavaException ()
9191
{
92-
JniEnvironment.Runtime.ValueManager.Finalize (this);
92+
JniEnvironment.Runtime.ValueManager.FinalizePeer (this);
9393
}
9494

9595
public JniObjectReference PeerReference {
@@ -148,17 +148,17 @@ public void UnregisterFromRuntime ()
148148
{
149149
if (!PeerReference.IsValid)
150150
throw new ObjectDisposedException (GetType ().FullName);
151-
JniEnvironment.Runtime.ValueManager.Remove (this);
151+
JniEnvironment.Runtime.ValueManager.RemovePeer (this);
152152
}
153153

154154
public void Dispose ()
155155
{
156-
JniEnvironment.Runtime.ValueManager.Dispose (this);
156+
JniEnvironment.Runtime.ValueManager.DisposePeer (this);
157157
}
158158

159159
public void DisposeUnlessReferenced ()
160160
{
161-
JniEnvironment.Runtime.ValueManager.DisposeUnlessReferenced (this);
161+
JniEnvironment.Runtime.ValueManager.DisposePeerUnlessReferenced (this);
162162
}
163163

164164
protected virtual void Dispose (bool disposing)

src/Java.Interop/Java.Interop/JavaObject.cs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ unsafe public class JavaObject : IJavaPeerable
2828

2929
~JavaObject ()
3030
{
31-
JniEnvironment.Runtime.ValueManager.Finalize (this);
31+
JniEnvironment.Runtime.ValueManager.FinalizePeer (this);
3232
}
3333

3434
public JniObjectReference PeerReference {
@@ -75,7 +75,7 @@ public unsafe JavaObject ()
7575

7676
protected void Construct (ref JniObjectReference reference, JniObjectReferenceOptions options)
7777
{
78-
JniEnvironment.Runtime.ValueManager.Construct (this, ref reference, options);
78+
JniEnvironment.Runtime.ValueManager.ConstructPeer (this, ref reference, options);
7979
}
8080

8181
protected void SetPeerReference (ref JniObjectReference reference, JniObjectReferenceOptions options)
@@ -100,17 +100,17 @@ public void UnregisterFromRuntime ()
100100
{
101101
if (!PeerReference.IsValid)
102102
throw new ObjectDisposedException (GetType ().FullName);
103-
JniEnvironment.Runtime.ValueManager.Remove (this);
103+
JniEnvironment.Runtime.ValueManager.RemovePeer (this);
104104
}
105105

106106
public void Dispose ()
107107
{
108-
JniEnvironment.Runtime.ValueManager.Dispose (this);
108+
JniEnvironment.Runtime.ValueManager.DisposePeer (this);
109109
}
110110

111111
public void DisposeUnlessReferenced ()
112112
{
113-
JniEnvironment.Runtime.ValueManager.DisposeUnlessReferenced (this);
113+
JniEnvironment.Runtime.ValueManager.DisposePeerUnlessReferenced (this);
114114
}
115115

116116
protected virtual void Dispose (bool disposing)

src/Java.Interop/Java.Interop/JniRuntime.JniValueManager.cs

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -64,15 +64,15 @@ protected virtual void Dispose (bool disposing)
6464

6565
public abstract void Collect ();
6666

67-
public abstract void Add (IJavaPeerable value);
67+
public abstract void AddPeer (IJavaPeerable value);
6868

69-
public abstract void Remove (IJavaPeerable value);
69+
public abstract void RemovePeer (IJavaPeerable value);
7070

71-
public abstract void Finalize (IJavaPeerable value);
71+
public abstract void FinalizePeer (IJavaPeerable value);
7272

7373
public abstract List<JniSurfacedPeerInfo> GetSurfacedPeers ();
7474

75-
public void Construct (IJavaPeerable peer, ref JniObjectReference reference, JniObjectReferenceOptions options)
75+
public void ConstructPeer (IJavaPeerable peer, ref JniObjectReference reference, JniObjectReferenceOptions options)
7676
{
7777
if (peer == null)
7878
throw new ArgumentNullException (nameof (peer));
@@ -112,7 +112,7 @@ public void Construct (IJavaPeerable peer, ref JniObjectReference reference, Jni
112112
}
113113

114114
if ((options & DoNotRegisterTarget) != DoNotRegisterTarget) {
115-
Add (peer);
115+
AddPeer (peer);
116116
}
117117
}
118118

@@ -121,7 +121,7 @@ public int GetJniIdentityHashCode (JniObjectReference reference)
121121
return JniSystem.IdentityHashCode (reference);
122122
}
123123

124-
public virtual void Dispose (IJavaPeerable value)
124+
public virtual void DisposePeer (IJavaPeerable value)
125125
{
126126
if (value == null)
127127
throw new ArgumentNullException (nameof (value));
@@ -130,13 +130,13 @@ public virtual void Dispose (IJavaPeerable value)
130130
if (!h.IsValid)
131131
return;
132132

133-
Dispose (h, value);
133+
DisposePeer (h, value);
134134
}
135135

136-
void Dispose (JniObjectReference h, IJavaPeerable value)
136+
void DisposePeer (JniObjectReference h, IJavaPeerable value)
137137
{
138138
value.Disposed ();
139-
Remove (value);
139+
RemovePeer (value);
140140
var o = Runtime.ObjectReferenceManager;
141141
if (o.LogGlobalReferenceMessages) {
142142
o.WriteGlobalReferenceLine ("Disposing PeerReference={0} IdentityHashCode=0x{1} Instance=0x{2} Instance.Type={3} Java.Type={4}",
@@ -160,7 +160,7 @@ void Dispose (JniObjectReference h, IJavaPeerable value)
160160
GC.SuppressFinalize (value);
161161
}
162162

163-
public virtual void DisposeUnlessReferenced (IJavaPeerable value)
163+
public virtual void DisposePeerUnlessReferenced (IJavaPeerable value)
164164
{
165165
if (value == null)
166166
throw new ArgumentNullException (nameof (value));
@@ -173,7 +173,7 @@ public virtual void DisposeUnlessReferenced (IJavaPeerable value)
173173
if (o != null && object.ReferenceEquals (o, value))
174174
return;
175175

176-
Dispose (h, value);
176+
DisposePeer (h, value);
177177
}
178178

179179
public abstract IJavaPeerable PeekPeer (JniObjectReference reference);
@@ -188,12 +188,12 @@ public object PeekValue (JniObjectReference reference)
188188
return t;
189189

190190
object r;
191-
return TryUnboxObject (t, out r)
191+
return TryUnboxPeerObject (t, out r)
192192
? r
193193
: t;
194194
}
195195

196-
protected virtual bool TryUnboxObject (IJavaPeerable value, out object result)
196+
protected virtual bool TryUnboxPeerObject (IJavaPeerable value, out object result)
197197
{
198198
result = null;
199199
var p = value as JavaProxyObject;
@@ -215,7 +215,7 @@ object PeekBoxedObject (JniObjectReference reference)
215215
if (t == null)
216216
return null;
217217
object r;
218-
return TryUnboxObject (t, out r)
218+
return TryUnboxPeerObject (t, out r)
219219
? r
220220
: null;
221221
}

src/Java.Interop/Tests/Java.Interop/JniRuntime.JniValueManagerTests.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,15 +38,15 @@ public override void Collect ()
3838
{
3939
}
4040

41-
public override void Add (IJavaPeerable reference)
41+
public override void AddPeer (IJavaPeerable reference)
4242
{
4343
}
4444

45-
public override void Remove (IJavaPeerable reference)
45+
public override void RemovePeer (IJavaPeerable reference)
4646
{
4747
}
4848

49-
public override void Finalize (IJavaPeerable reference)
49+
public override void FinalizePeer (IJavaPeerable reference)
5050
{
5151
}
5252

src/Java.Interop/Tests/Java.Interop/JniRuntimeTest.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -129,15 +129,15 @@ public override int WeakGlobalReferenceCount {
129129

130130
class ProxyValueManager : JniValueManager {
131131

132-
public override void Add (IJavaPeerable peer)
132+
public override void AddPeer (IJavaPeerable peer)
133133
{
134134
}
135135

136136
public override void Collect ()
137137
{
138138
}
139139

140-
public override void Finalize (IJavaPeerable peer)
140+
public override void FinalizePeer (IJavaPeerable peer)
141141
{
142142
}
143143

@@ -151,7 +151,7 @@ public override IJavaPeerable PeekPeer (JniObjectReference reference)
151151
return null;
152152
}
153153

154-
public override void Remove (IJavaPeerable peer)
154+
public override void RemovePeer (IJavaPeerable peer)
155155
{
156156
}
157157

src/Java.Runtime.Environment/Java.Interop/MonoRuntimeValueManager.cs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ public override List<JniSurfacedPeerInfo> GetSurfacedPeers ()
101101
}
102102
}
103103

104-
public override void Add (IJavaPeerable value)
104+
public override void AddPeer (IJavaPeerable value)
105105
{
106106
var r = value.PeerReference;
107107
if (!r.IsValid)
@@ -169,7 +169,7 @@ static bool Replaceable (IJavaPeerable peer)
169169
return (peer.JniManagedPeerState & JniManagedPeerStates.Replaceable) == JniManagedPeerStates.Replaceable;
170170
}
171171

172-
public override void Remove (IJavaPeerable value)
172+
public override void RemovePeer (IJavaPeerable value)
173173
{
174174
if (value == null)
175175
throw new ArgumentNullException (nameof (value));
@@ -226,7 +226,7 @@ public override IJavaPeerable PeekPeer (JniObjectReference reference)
226226
return null;
227227
}
228228

229-
public override void Finalize (IJavaPeerable value)
229+
public override void FinalizePeer (IJavaPeerable value)
230230
{
231231
var h = value.PeerReference;
232232
var o = Runtime.ObjectReferenceManager;
@@ -242,7 +242,7 @@ public override void Finalize (IJavaPeerable value)
242242
RuntimeHelpers.GetHashCode (value).ToString ("x"),
243243
value.GetType ().ToString ());
244244
}
245-
Remove (value);
245+
RemovePeer (value);
246246
value.SetPeerReference (new JniObjectReference ());
247247
value.Finalized ();
248248
return;
@@ -251,7 +251,7 @@ public override void Finalize (IJavaPeerable value)
251251
try {
252252
bool collected = TryGC (value, ref h);
253253
if (collected) {
254-
Remove (value);
254+
RemovePeer (value);
255255
value.SetPeerReference (new JniObjectReference ());
256256
if (o.LogGlobalReferenceMessages) {
257257
o.WriteGlobalReferenceLine ("Finalizing PeerReference={0} IdentityHashCode=0x{1} Instance=0x{2} Instance.Type={3}",

0 commit comments

Comments
 (0)