-
Notifications
You must be signed in to change notification settings - Fork 0
/
ITemporalAccessor.xml
327 lines (327 loc) · 23.8 KB
/
ITemporalAccessor.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
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
<Type Name="ITemporalAccessor" FullName="Java.Time.Temporal.ITemporalAccessor">
<TypeSignature Language="C#" Value="public interface ITemporalAccessor : Android.Runtime.IJavaObject, IDisposable, Java.Interop.IJavaPeerable" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit ITemporalAccessor implements class Android.Runtime.IJavaObject, class Java.Interop.IJavaPeerable, class System.IDisposable" />
<TypeSignature Language="DocId" Value="T:Java.Time.Temporal.ITemporalAccessor" />
<TypeSignature Language="F#" Value="type ITemporalAccessor = interface
 interface IJavaObject
 interface IDisposable
 interface IJavaPeerable" />
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces>
<Interface>
<InterfaceName>Android.Runtime.IJavaObject</InterfaceName>
</Interface>
<Interface>
<InterfaceName>Java.Interop.IJavaPeerable</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("java/time/temporal/TemporalAccessor", "", "Java.Time.Temporal.ITemporalAccessorInvoker", ApiSince=26)]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("java/time/temporal/TemporalAccessor", "", "Java.Time.Temporal.ITemporalAccessorInvoker", ApiSince=26)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Framework-level interface defining read-only access to a temporal object,
such as a date, time, offset or some combination of these.</summary>
<remarks>
<para>Framework-level interface defining read-only access to a temporal object,
such as a date, time, offset or some combination of these.</para>
<para>This is the base interface type for date, time and offset objects.
It is implemented by those classes that can provide information
as TemporalField fields or TemporalQuery queries.</para>
<para>Most date and time information can be represented as a number.
These are modeled using <c>TemporalField</c> with the number held using
a <c>long</c> to handle large values. Year, month and day-of-month are
simple examples of fields, but they also include instant and offsets.
See <c>ChronoField</c> for the standard set of fields.</para>
<para>Two pieces of date/time information cannot be represented by numbers,
the java.time.chrono.Chronology chronology and the
java.time.ZoneId time-zone.
These can be accessed via #query(TemporalQuery) queries using
the static methods defined on <c>TemporalQuery</c>.</para>
<para>A sub-interface, <c>Temporal</c>, extends this definition to one that also
supports adjustment and manipulation on more complete temporal objects.</para>
<para>This interface is a framework-level interface that should not be widely
used in application code. Instead, applications should create and pass
around instances of concrete types, such as <c>LocalDate</c>.
There are many reasons for this, part of which is that implementations
of this interface may be in calendar systems other than ISO.
See <c>java.time.chrono.ChronoLocalDate</c> for a fuller discussion of the issues.</para>
<para>Added in 1.8.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/time/temporal/TemporalAccessor" title="Reference documentation">Java documentation for <code>java.time.temporal.TemporalAccessor</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>
<Members>
<Member MemberName="Get">
<MemberSignature Language="C#" Value="public virtual int Get (Java.Time.Temporal.ITemporalField? field);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance int32 Get(class Java.Time.Temporal.ITemporalField field) cil managed" />
<MemberSignature Language="DocId" Value="M:Java.Time.Temporal.ITemporalAccessor.Get(Java.Time.Temporal.ITemporalField)" />
<MemberSignature Language="F#" Value="abstract member Get : Java.Time.Temporal.ITemporalField -> int
override this.Get : Java.Time.Temporal.ITemporalField -> int" Usage="iTemporalAccessor.Get field" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("get", "(Ljava/time/temporal/TemporalField;)I", "GetGet_Ljava_time_temporal_TemporalField_Handler:Java.Time.Temporal.ITemporalAccessor, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null", ApiSince=26)]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("get", "(Ljava/time/temporal/TemporalField;)I", "GetGet_Ljava_time_temporal_TemporalField_Handler:Java.Time.Temporal.ITemporalAccessor, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null", ApiSince=26)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android26.0")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Versioning.SupportedOSPlatform("android26.0")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="field" Type="Java.Time.Temporal.ITemporalField" />
</Parameters>
<Docs>
<param name="field">the field to get, not null</param>
<summary>Gets the value of the specified field as an <c>int</c>.</summary>
<returns>the value for the field, within the valid range of values</returns>
<remarks>
<para>Gets the value of the specified field as an <c>int</c>.</para>
<para>This queries the date-time for the value of the specified field.
The returned value will always be within the valid range of values for the field.
If the date-time cannot return the value, because the field is unsupported or for
some other reason, an exception will be thrown.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/time/temporal/TemporalAccessor#get(java.time.temporal.TemporalField)" title="Reference documentation">Java documentation for <code>java.time.temporal.TemporalAccessor.get(java.time.temporal.TemporalField)</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="GetLong">
<MemberSignature Language="C#" Value="public long GetLong (Java.Time.Temporal.ITemporalField? field);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance int64 GetLong(class Java.Time.Temporal.ITemporalField field) cil managed" />
<MemberSignature Language="DocId" Value="M:Java.Time.Temporal.ITemporalAccessor.GetLong(Java.Time.Temporal.ITemporalField)" />
<MemberSignature Language="F#" Value="abstract member GetLong : Java.Time.Temporal.ITemporalField -> int64" Usage="iTemporalAccessor.GetLong field" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("getLong", "(Ljava/time/temporal/TemporalField;)J", "GetGetLong_Ljava_time_temporal_TemporalField_Handler:Java.Time.Temporal.ITemporalAccessorInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null", ApiSince=26)]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("getLong", "(Ljava/time/temporal/TemporalField;)J", "GetGetLong_Ljava_time_temporal_TemporalField_Handler:Java.Time.Temporal.ITemporalAccessorInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null", ApiSince=26)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android26.0")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Versioning.SupportedOSPlatform("android26.0")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="field" Type="Java.Time.Temporal.ITemporalField" />
</Parameters>
<Docs>
<param name="field">the field to get, not null</param>
<summary>Gets the value of the specified field as a <c>long</c>.</summary>
<returns>the value for the field</returns>
<remarks>
<para>Gets the value of the specified field as a <c>long</c>.</para>
<para>This queries the date-time for the value of the specified field.
The returned value may be outside the valid range of values for the field.
If the date-time cannot return the value, because the field is unsupported or for
some other reason, an exception will be thrown.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/time/temporal/TemporalAccessor#getLong(java.time.temporal.TemporalField)" title="Reference documentation">Java documentation for <code>java.time.temporal.TemporalAccessor.getLong(java.time.temporal.TemporalField)</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="IsSupported">
<MemberSignature Language="C#" Value="public bool IsSupported (Java.Time.Temporal.ITemporalField? field);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool IsSupported(class Java.Time.Temporal.ITemporalField field) cil managed" />
<MemberSignature Language="DocId" Value="M:Java.Time.Temporal.ITemporalAccessor.IsSupported(Java.Time.Temporal.ITemporalField)" />
<MemberSignature Language="F#" Value="abstract member IsSupported : Java.Time.Temporal.ITemporalField -> bool" Usage="iTemporalAccessor.IsSupported field" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("isSupported", "(Ljava/time/temporal/TemporalField;)Z", "GetIsSupported_Ljava_time_temporal_TemporalField_Handler:Java.Time.Temporal.ITemporalAccessorInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null", ApiSince=26)]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("isSupported", "(Ljava/time/temporal/TemporalField;)Z", "GetIsSupported_Ljava_time_temporal_TemporalField_Handler:Java.Time.Temporal.ITemporalAccessorInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null", ApiSince=26)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android26.0")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Versioning.SupportedOSPlatform("android26.0")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="field" Type="Java.Time.Temporal.ITemporalField" />
</Parameters>
<Docs>
<param name="field">the field to check, null returns false</param>
<summary>Checks if the specified field is supported.</summary>
<returns>true if this date-time can be queried for the field, false if not</returns>
<remarks>
<para>Checks if the specified field is supported.</para>
<para>This checks if the date-time can be queried for the specified field.
If false, then calling the <c>#range(TemporalField) range</c> and <c>#get(TemporalField) get</c>
methods will throw an exception.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/time/temporal/TemporalAccessor#isSupported(java.time.temporal.TemporalField)" title="Reference documentation">Java documentation for <code>java.time.temporal.TemporalAccessor.isSupported(java.time.temporal.TemporalField)</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="Query">
<MemberSignature Language="C#" Value="public virtual Java.Lang.Object? Query (Java.Time.Temporal.ITemporalQuery? query);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Java.Lang.Object Query(class Java.Time.Temporal.ITemporalQuery query) cil managed" />
<MemberSignature Language="DocId" Value="M:Java.Time.Temporal.ITemporalAccessor.Query(Java.Time.Temporal.ITemporalQuery)" />
<MemberSignature Language="F#" Value="abstract member Query : Java.Time.Temporal.ITemporalQuery -> Java.Lang.Object
override this.Query : Java.Time.Temporal.ITemporalQuery -> Java.Lang.Object" Usage="iTemporalAccessor.Query query" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("query", "(Ljava/time/temporal/TemporalQuery;)Ljava/lang/Object;", "GetQuery_Ljava_time_temporal_TemporalQuery_Handler:Java.Time.Temporal.ITemporalAccessor, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null", ApiSince=26)]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("query", "(Ljava/time/temporal/TemporalQuery;)Ljava/lang/Object;", "GetQuery_Ljava_time_temporal_TemporalQuery_Handler:Java.Time.Temporal.ITemporalAccessor, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null", ApiSince=26)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[Java.Interop.JavaTypeParameters(new System.String[] { "R" })]</AttributeName>
<AttributeName Language="F#">[<Java.Interop.JavaTypeParameters(new System.String[] { "R" })>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android26.0")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Versioning.SupportedOSPlatform("android26.0")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Java.Lang.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="query" Type="Java.Time.Temporal.ITemporalQuery" />
</Parameters>
<Docs>
<param name="<R><R>">the type of the result</param>
<param name="query">the query to invoke, not null</param>
<summary>Queries this date-time.</summary>
<returns>the query result, null may be returned (defined by the query)</returns>
<remarks>
<para>Queries this date-time.</para>
<para>This queries this date-time using the specified query strategy object.</para>
<para>Queries are a key tool for extracting information from date-times.
They exists to externalize the process of querying, permitting different
approaches, as per the strategy design pattern.
Examples might be a query that checks if the date is the day before February 29th
in a leap year, or calculates the number of days to your next birthday.</para>
<para>The most common query implementations are method references, such as
<c>LocalDate::from</c> and <c>ZoneId::from</c>.
Additional implementations are provided as static methods on <c>TemporalQuery</c>.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/time/temporal/TemporalAccessor#query(java.time.temporal.TemporalQuery%3CR%3E)" title="Reference documentation">Java documentation for <code>java.time.temporal.TemporalAccessor.query(java.time.temporal.TemporalQuery<R>)</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="Range">
<MemberSignature Language="C#" Value="public virtual Java.Time.Temporal.ValueRange? Range (Java.Time.Temporal.ITemporalField? field);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Java.Time.Temporal.ValueRange Range(class Java.Time.Temporal.ITemporalField field) cil managed" />
<MemberSignature Language="DocId" Value="M:Java.Time.Temporal.ITemporalAccessor.Range(Java.Time.Temporal.ITemporalField)" />
<MemberSignature Language="F#" Value="abstract member Range : Java.Time.Temporal.ITemporalField -> Java.Time.Temporal.ValueRange
override this.Range : Java.Time.Temporal.ITemporalField -> Java.Time.Temporal.ValueRange" Usage="iTemporalAccessor.Range field" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("range", "(Ljava/time/temporal/TemporalField;)Ljava/time/temporal/ValueRange;", "GetRange_Ljava_time_temporal_TemporalField_Handler:Java.Time.Temporal.ITemporalAccessor, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null", ApiSince=26)]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("range", "(Ljava/time/temporal/TemporalField;)Ljava/time/temporal/ValueRange;", "GetRange_Ljava_time_temporal_TemporalField_Handler:Java.Time.Temporal.ITemporalAccessor, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null", ApiSince=26)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android26.0")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Versioning.SupportedOSPlatform("android26.0")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Java.Time.Temporal.ValueRange</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="field" Type="Java.Time.Temporal.ITemporalField" />
</Parameters>
<Docs>
<param name="field">the field to query the range for, not null</param>
<summary>Gets the range of valid values for the specified field.</summary>
<returns>the range of valid values for the field, not null</returns>
<remarks>
<para>Gets the range of valid values for the specified field.</para>
<para>All fields can be expressed as a <c>long</c> integer.
This method returns an object that describes the valid range for that value.
The value of this temporal object is used to enhance the accuracy of the returned range.
If the date-time cannot return the range, because the field is unsupported or for
some other reason, an exception will be thrown.</para>
<para>Note that the result only describes the minimum and maximum valid values
and it is important not to read too much into them. For example, there
could be values within the range that are invalid for the field.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/time/temporal/TemporalAccessor#range(java.time.temporal.TemporalField)" title="Reference documentation">Java documentation for <code>java.time.temporal.TemporalAccessor.range(java.time.temporal.TemporalField)</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>
</Members>
</Type>