-
Notifications
You must be signed in to change notification settings - Fork 0
/
SoftReference.xml
269 lines (268 loc) · 18.5 KB
/
SoftReference.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
<Type Name="SoftReference" FullName="Java.Lang.Ref.SoftReference">
<TypeSignature Language="C#" Value="public class SoftReference : Java.Lang.Ref.Reference" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SoftReference extends Java.Lang.Ref.Reference" />
<TypeSignature Language="DocId" Value="T:Java.Lang.Ref.SoftReference" />
<TypeSignature Language="F#" Value="type SoftReference = class
 inherit Reference" />
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Java.Lang.Ref.Reference</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("java/lang/ref/SoftReference", DoNotGenerateAcw=true)]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("java/lang/ref/SoftReference", DoNotGenerateAcw=true)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[Java.Interop.JavaTypeParameters(new System.String[] { "T" })]</AttributeName>
<AttributeName Language="F#">[<Java.Interop.JavaTypeParameters(new System.String[] { "T" })>]</AttributeName>
</Attribute>
</Attributes>
<Docs since="1">
<summary>Soft reference objects, which are cleared at the discretion of the garbage
collector in response to memory demand.</summary>
<remarks>
<para>Soft reference objects, which are cleared at the discretion of the garbage
collector in response to memory demand.</para>
<para>Suppose that the garbage collector determines at a certain point in time
that an object is softly
reachable. At that time it may choose to clear atomically all soft
references to that object and all soft references to any other
softly-reachable objects from which that object is reachable through a chain
of strong references. At the same time or at some later time it will
enqueue those newly-cleared soft references that are registered with
reference queues.</para>
<para>All soft references to softly-reachable objects are guaranteed to have
been cleared before the virtual machine throws an
<c>OutOfMemoryError</c>. Otherwise no constraints are placed upon the
time at which a soft reference will be cleared or the order in which a set
of such references to different objects will be cleared. Virtual machine
implementations are, however, encouraged to bias against clearing
recently-created or recently-used soft references.
<h3>Avoid Soft References for Caching</h3>
In practice, soft references are inefficient for caching. The runtime doesn't
have enough information on which references to clear and which to keep. Most
fatally, it doesn't know what to do when given the choice between clearing a
soft reference and growing the heap.</para>
<para>The lack of information on the value to your application of each reference
limits the usefulness of soft references. References that are cleared too
early cause unnecessary work; those that are cleared too late waste memory.</para>
<para>Most applications should use an <c>android.util.LruCache</c> instead of
soft references. LruCache has an effective eviction policy and lets the user
tune how much memory is allotted.</para>
<para>Added in 1.2.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/lang/ref/SoftReference" title="Reference documentation">Java documentation for <code>java.lang.ref.SoftReference</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SoftReference (Java.Lang.Object? referent);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Java.Lang.Object referent) cil managed" />
<MemberSignature Language="DocId" Value="M:Java.Lang.Ref.SoftReference.#ctor(Java.Lang.Object)" />
<MemberSignature Language="F#" Value="new Java.Lang.Ref.SoftReference : Java.Lang.Object -> Java.Lang.Ref.SoftReference" Usage="new Java.Lang.Ref.SoftReference referent" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register(".ctor", "(Ljava/lang/Object;)V", "")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register(".ctor", "(Ljava/lang/Object;)V", "")>]</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="referent" Type="Java.Lang.Object" />
</Parameters>
<Docs>
<param name="referent">object the new soft reference will refer to</param>
<summary>Creates a new soft reference that refers to the given object.</summary>
<remarks>
<para>Creates a new soft reference that refers to the given object. The new
reference is not registered with any queue.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/lang/ref/SoftReference#SoftReference(T)" title="Reference documentation">Java documentation for <code>java.lang.ref.SoftReference.SoftReference(T)</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SoftReference (Java.Lang.Object? referent, Java.Lang.Ref.ReferenceQueue? q);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Java.Lang.Object referent, class Java.Lang.Ref.ReferenceQueue q) cil managed" />
<MemberSignature Language="DocId" Value="M:Java.Lang.Ref.SoftReference.#ctor(Java.Lang.Object,Java.Lang.Ref.ReferenceQueue)" />
<MemberSignature Language="F#" Value="new Java.Lang.Ref.SoftReference : Java.Lang.Object * Java.Lang.Ref.ReferenceQueue -> Java.Lang.Ref.SoftReference" Usage="new Java.Lang.Ref.SoftReference (referent, q)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register(".ctor", "(Ljava/lang/Object;Ljava/lang/ref/ReferenceQueue;)V", "")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register(".ctor", "(Ljava/lang/Object;Ljava/lang/ref/ReferenceQueue;)V", "")>]</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="referent" Type="Java.Lang.Object" />
<Parameter Name="q" Type="Java.Lang.Ref.ReferenceQueue" />
</Parameters>
<Docs>
<param name="referent">object the new soft reference will refer to</param>
<param name="q">the queue with which the reference is to be registered,
or <c>null</c> if registration is not required</param>
<summary>Creates a new soft reference that refers to the given object and is
registered with the given queue.</summary>
<remarks>
<para>Creates a new soft reference that refers to the given object and is
registered with the given queue.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/lang/ref/SoftReference#SoftReference(T,%20java.lang.ref.ReferenceQueue%3C?%20super%20T%3E)" title="Reference documentation">Java documentation for <code>java.lang.ref.SoftReference.SoftReference(T, java.lang.ref.ReferenceQueue<? super T>)</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected SoftReference (IntPtr javaReference, Android.Runtime.JniHandleOwnership transfer);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(native int javaReference, valuetype Android.Runtime.JniHandleOwnership transfer) cil managed" />
<MemberSignature Language="DocId" Value="M:Java.Lang.Ref.SoftReference.#ctor(System.IntPtr,Android.Runtime.JniHandleOwnership)" />
<MemberSignature Language="F#" Value="new Java.Lang.Ref.SoftReference : nativeint * Android.Runtime.JniHandleOwnership -> Java.Lang.Ref.SoftReference" Usage="new Java.Lang.Ref.SoftReference (javaReference, transfer)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="javaReference" Type="System.IntPtr" />
<Parameter Name="transfer" Type="Android.Runtime.JniHandleOwnership" />
</Parameters>
<Docs>
<param name="javaReference">A <see cref="T:System.IntPtr" />containing a Java Native Interface (JNI) object reference.</param>
<param name="transfer">A <see cref="T:Android.Runtime.JniHandleOwnership" />indicating how to handle <paramref name="javaReference" /></param>
<summary>A constructor used when creating managed representations of JNI objects; called by the runtime.</summary>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="JniPeerMembers">
<MemberSignature Language="C#" Value="public override Java.Interop.JniPeerMembers JniPeerMembers { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Java.Interop.JniPeerMembers JniPeerMembers" />
<MemberSignature Language="DocId" Value="P:Java.Lang.Ref.SoftReference.JniPeerMembers" />
<MemberSignature Language="F#" Value="member this.JniPeerMembers : Java.Interop.JniPeerMembers" Usage="Java.Lang.Ref.SoftReference.JniPeerMembers" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Diagnostics.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Java.Interop.JniPeerMembers</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="ThresholdClass">
<MemberSignature Language="C#" Value="protected override IntPtr ThresholdClass { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance native int ThresholdClass" />
<MemberSignature Language="DocId" Value="P:Java.Lang.Ref.SoftReference.ThresholdClass" />
<MemberSignature Language="F#" Value="member this.ThresholdClass : nativeint" Usage="Java.Lang.Ref.SoftReference.ThresholdClass" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Diagnostics.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.IntPtr</ReturnType>
</ReturnValue>
<Docs>
<summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>
<value>A <see cref="T:System.IntPtr" /> which contains the <c>java.lang.Class</c> JNI value corresponding to this type.</value>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="ThresholdType">
<MemberSignature Language="C#" Value="protected override Type ThresholdType { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Type ThresholdType" />
<MemberSignature Language="DocId" Value="P:Java.Lang.Ref.SoftReference.ThresholdType" />
<MemberSignature Language="F#" Value="member this.ThresholdType : Type" Usage="Java.Lang.Ref.SoftReference.ThresholdType" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Diagnostics.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Type</ReturnType>
</ReturnValue>
<Docs>
<summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>
<value>A <see cref="T:System.Type" /> which provides the declaring type.</value>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
</Members>
</Type>