/
ITemporalAmount.xml
253 lines (253 loc) · 17.5 KB
/
ITemporalAmount.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
<Type Name="ITemporalAmount" FullName="Java.Time.Temporal.ITemporalAmount">
<TypeSignature Language="C#" Value="public interface ITemporalAmount : Android.Runtime.IJavaObject, IDisposable, Java.Interop.IJavaPeerable" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit ITemporalAmount implements class Android.Runtime.IJavaObject, class Java.Interop.IJavaPeerable, class System.IDisposable" />
<TypeSignature Language="DocId" Value="T:Java.Time.Temporal.ITemporalAmount" />
<TypeSignature Language="F#" Value="type ITemporalAmount = 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/TemporalAmount", "", "Java.Time.Temporal.ITemporalAmountInvoker", ApiSince=26)]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("java/time/temporal/TemporalAmount", "", "Java.Time.Temporal.ITemporalAmountInvoker", ApiSince=26)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Framework-level interface defining an amount of time, such as
"6 hours", "8 days" or "2 years and 3 months".</summary>
<remarks>
<para>Framework-level interface defining an amount of time, such as
"6 hours", "8 days" or "2 years and 3 months".</para>
<para>This is the base interface type for amounts of time.
An amount is distinct from a date or time-of-day in that it is not tied
to any specific point on the time-line.</para>
<para>The amount can be thought of as a <c>Map</c> of <c>TemporalUnit</c> to
<c>long</c>, exposed via <c>#getUnits()</c> and <c>#get(TemporalUnit)</c>.
A simple case might have a single unit-value pair, such as "6 hours".
A more complex case may have multiple unit-value pairs, such as
"7 years, 3 months and 5 days".</para>
<para>There are two common implementations.
<c>Period</c> is a date-based implementation, storing years, months and days.
<c>Duration</c> is a time-based implementation, storing seconds and nanoseconds,
but providing some access using other duration based units such as minutes,
hours and fixed 24-hour days.</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>Period</c> and <c>Duration</c>.</para>
<para>Added in 1.8.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/time/temporal/TemporalAmount" title="Reference documentation">Java documentation for <code>java.time.temporal.TemporalAmount</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="AddTo">
<MemberSignature Language="C#" Value="public Java.Time.Temporal.ITemporal? AddTo (Java.Time.Temporal.ITemporal? temporal);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Java.Time.Temporal.ITemporal AddTo(class Java.Time.Temporal.ITemporal temporal) cil managed" />
<MemberSignature Language="DocId" Value="M:Java.Time.Temporal.ITemporalAmount.AddTo(Java.Time.Temporal.ITemporal)" />
<MemberSignature Language="F#" Value="abstract member AddTo : Java.Time.Temporal.ITemporal -> Java.Time.Temporal.ITemporal" Usage="iTemporalAmount.AddTo temporal" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("addTo", "(Ljava/time/temporal/Temporal;)Ljava/time/temporal/Temporal;", "GetAddTo_Ljava_time_temporal_Temporal_Handler:Java.Time.Temporal.ITemporalAmountInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null", ApiSince=26)]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("addTo", "(Ljava/time/temporal/Temporal;)Ljava/time/temporal/Temporal;", "GetAddTo_Ljava_time_temporal_Temporal_Handler:Java.Time.Temporal.ITemporalAmountInvoker, 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.ITemporal</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="temporal" Type="Java.Time.Temporal.ITemporal" />
</Parameters>
<Docs>
<param name="temporal">the temporal object to add the amount to, not null</param>
<summary>Adds to the specified temporal object.</summary>
<returns>an object of the same observable type with the addition made, not null</returns>
<remarks>
<para>Adds to the specified temporal object.</para>
<para>Adds the amount to the specified temporal object using the logic
encapsulated in the implementing class.</para>
<para>There are two equivalent ways of using this method.
The first is to invoke this method directly.
The second is to use <c>Temporal#plus(TemporalAmount)</c>:</para>
<code lang="text/java">// These two lines are equivalent, but the second approach is recommended
dateTime = amount.addTo(dateTime);
dateTime = dateTime.plus(adder);
</code>
<para>It is recommended to use the second approach, <c>plus(TemporalAmount)</c>,
as it is a lot clearer to read in code.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/time/temporal/TemporalAmount#addTo(java.time.temporal.Temporal)" title="Reference documentation">Java documentation for <code>java.time.temporal.TemporalAmount.addTo(java.time.temporal.Temporal)</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="Get">
<MemberSignature Language="C#" Value="public long Get (Java.Time.Temporal.ITemporalUnit? unit);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance int64 Get(class Java.Time.Temporal.ITemporalUnit unit) cil managed" />
<MemberSignature Language="DocId" Value="M:Java.Time.Temporal.ITemporalAmount.Get(Java.Time.Temporal.ITemporalUnit)" />
<MemberSignature Language="F#" Value="abstract member Get : Java.Time.Temporal.ITemporalUnit -> int64" Usage="iTemporalAmount.Get unit" />
<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/TemporalUnit;)J", "GetGet_Ljava_time_temporal_TemporalUnit_Handler:Java.Time.Temporal.ITemporalAmountInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null", ApiSince=26)]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("get", "(Ljava/time/temporal/TemporalUnit;)J", "GetGet_Ljava_time_temporal_TemporalUnit_Handler:Java.Time.Temporal.ITemporalAmountInvoker, 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="unit" Type="Java.Time.Temporal.ITemporalUnit" />
</Parameters>
<Docs>
<param name="unit">the <c>TemporalUnit</c> for which to return the value</param>
<summary>Returns the value of the requested unit.</summary>
<returns>the long value of the unit</returns>
<remarks>
<para>Returns the value of the requested unit.
The units returned from <c>#getUnits()</c> uniquely define the
value of the <c>TemporalAmount</c>. A value must be returned
for each unit listed in <c>getUnits</c>.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/time/temporal/TemporalAmount#get(java.time.temporal.TemporalUnit)" title="Reference documentation">Java documentation for <code>java.time.temporal.TemporalAmount.get(java.time.temporal.TemporalUnit)</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="SubtractFrom">
<MemberSignature Language="C#" Value="public Java.Time.Temporal.ITemporal? SubtractFrom (Java.Time.Temporal.ITemporal? temporal);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Java.Time.Temporal.ITemporal SubtractFrom(class Java.Time.Temporal.ITemporal temporal) cil managed" />
<MemberSignature Language="DocId" Value="M:Java.Time.Temporal.ITemporalAmount.SubtractFrom(Java.Time.Temporal.ITemporal)" />
<MemberSignature Language="F#" Value="abstract member SubtractFrom : Java.Time.Temporal.ITemporal -> Java.Time.Temporal.ITemporal" Usage="iTemporalAmount.SubtractFrom temporal" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("subtractFrom", "(Ljava/time/temporal/Temporal;)Ljava/time/temporal/Temporal;", "GetSubtractFrom_Ljava_time_temporal_Temporal_Handler:Java.Time.Temporal.ITemporalAmountInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null", ApiSince=26)]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("subtractFrom", "(Ljava/time/temporal/Temporal;)Ljava/time/temporal/Temporal;", "GetSubtractFrom_Ljava_time_temporal_Temporal_Handler:Java.Time.Temporal.ITemporalAmountInvoker, 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.ITemporal</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="temporal" Type="Java.Time.Temporal.ITemporal" />
</Parameters>
<Docs>
<param name="temporal">the temporal object to subtract the amount from, not null</param>
<summary>Subtracts this object from the specified temporal object.</summary>
<returns>an object of the same observable type with the subtraction made, not null</returns>
<remarks>
<para>Subtracts this object from the specified temporal object.</para>
<para>Subtracts the amount from the specified temporal object using the logic
encapsulated in the implementing class.</para>
<para>There are two equivalent ways of using this method.
The first is to invoke this method directly.
The second is to use <c>Temporal#minus(TemporalAmount)</c>:</para>
<code lang="text/java">// these two lines are equivalent, but the second approach is recommended
dateTime = amount.subtractFrom(dateTime);
dateTime = dateTime.minus(amount);
</code>
<para>It is recommended to use the second approach, <c>minus(TemporalAmount)</c>,
as it is a lot clearer to read in code.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/time/temporal/TemporalAmount#subtractFrom(java.time.temporal.Temporal)" title="Reference documentation">Java documentation for <code>java.time.temporal.TemporalAmount.subtractFrom(java.time.temporal.Temporal)</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="Units">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Java.Time.Temporal.ITemporalUnit>? Units { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<class Java.Time.Temporal.ITemporalUnit> Units" />
<MemberSignature Language="DocId" Value="P:Java.Time.Temporal.ITemporalAmount.Units" />
<MemberSignature Language="F#" Value="member this.Units : System.Collections.Generic.IList<Java.Time.Temporal.ITemporalUnit>" Usage="Java.Time.Temporal.ITemporalAmount.Units" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[get: Android.Runtime.Register("getUnits", "()Ljava/util/List;", "GetGetUnitsHandler:Java.Time.Temporal.ITemporalAmountInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null", ApiSince=26)]</AttributeName>
<AttributeName Language="F#">[<get: Android.Runtime.Register("getUnits", "()Ljava/util/List;", "GetGetUnitsHandler:Java.Time.Temporal.ITemporalAmountInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null", ApiSince=26)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[get: System.Runtime.Versioning.SupportedOSPlatform("android26.0")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.Versioning.SupportedOSPlatform("android26.0")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<Java.Time.Temporal.ITemporalUnit></ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>