blob: 112679d240e1ba8cd7eadfef7249ce6edb81a2f8 [file] [log] [blame]
dacarver647c7352009-08-27 01:37:31 +00001<html><body><p><font size="+1"><strong>Package org.eclipse.wst.xml.xpath2.processor.internal.types</strong></font></p><hr><h2><font size="-1"><strong>org.eclipse.wst.xml.xpath2.processor.internal.types</strong></font><br>
2 Class XSYearMonthDuration</h2><br><hr><pre>public class <strong>XSYearMonthDuration</strong>
3extends org.eclipse.wst.xml.xpath2.processor.internal.types.XSDuration</pre>A representation of the YearMonthDuration datatype<hr><table width="100%" border="1"><tr bgcolor="#CCCCFF"><td width="100%"><h2>Constructor Summary</h2></td></tr><tr><td><code><strong><a href="#con_XSYearMonthDuration">XSYearMonthDuration</a></strong>(int year
4 ,
5 int month
6 ,
jmoller3a919172011-05-18 23:01:47 +00007 boolean negative)</code></td></tr><tr><td><code><strong><a href="#con_XSYearMonthDuration">XSYearMonthDuration</a></strong>(int months)</code></td></tr><tr><td><code><strong><a href="#con_XSYearMonthDuration">XSYearMonthDuration</a></strong>()</code></td></tr></table><br><table width="100%" border="1"><tr cols="2" bgcolor="#CCCCFF"><td colspan="2" width="100%"><h2>Method Summary</h2></td></tr><tr valign="top"><td width="20%" align="right"><code>public org.eclipse.wst.xml.xpath2.api.ResultSequence</code></td><td width="" align="left"><code><a href="#method_constructor">constructor</a>(org.eclipse.wst.xml.xpath2.api.ResultSequence arg)</code><br>
dacarver647c7352009-08-27 01:37:31 +00008 &nbsp;&nbsp;&nbsp;&nbsp;
9 Creates a new ResultSequence consisting of the extractable time duration
jmoller3a919172011-05-18 23:01:47 +000010 from the supplied ResultSequence</td></tr><tr valign="top"><td width="20%" align="right"><code>public org.eclipse.wst.xml.xpath2.api.ResultSequence</code></td><td width="" align="left"><code><a href="#method_div">div</a>(org.eclipse.wst.xml.xpath2.api.ResultSequence arg)</code><br>
dacarver647c7352009-08-27 01:37:31 +000011 &nbsp;&nbsp;&nbsp;&nbsp;
12 Mathematical division between this duration stored and the supplied
dacarver67d3b162010-04-13 12:50:19 +000013 duration of time (of type XSYearMonthDuration)</td></tr><tr valign="top"><td width="20%" align="right"><code>public boolean</code></td><td width="" align="left"><code><a href="#method_eq">eq</a>(org.eclipse.wst.xml.xpath2.processor.internal.types.AnyType arg
14 ,
jmoller3a919172011-05-18 23:01:47 +000015 org.eclipse.wst.xml.xpath2.api.DynamicContext dynamicContext)</code><br>
dacarver647c7352009-08-27 01:37:31 +000016 &nbsp;&nbsp;&nbsp;&nbsp;
jmoller3a919172011-05-18 23:01:47 +000017 Equality comparison between this and the supplied duration of time.</td></tr><tr valign="top"><td width="20%" align="right"><code>public java.lang.String</code></td><td width="" align="left"><code><a href="#method_getStringValue">getStringValue</a>()</code><br>
18 &nbsp;&nbsp;&nbsp;&nbsp;
19 Retrieves a String representation of the duration of time stored</td></tr><tr valign="top"><td width="20%" align="right"><code>public org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinition</code></td><td width="" align="left"><code><a href="#method_getTypeDefinition">getTypeDefinition</a>()</code><br>
20 &nbsp;&nbsp;&nbsp;&nbsp;
21 </td></tr><tr valign="top"><td width="20%" align="right"><code>public boolean</code></td><td width="" align="left"><code><a href="#method_gt">gt</a>(org.eclipse.wst.xml.xpath2.processor.internal.types.AnyType arg
dacarver67d3b162010-04-13 12:50:19 +000022 ,
jmoller3a919172011-05-18 23:01:47 +000023 org.eclipse.wst.xml.xpath2.api.DynamicContext context)</code><br>
dacarver647c7352009-08-27 01:37:31 +000024 &nbsp;&nbsp;&nbsp;&nbsp;
dacarver67d3b162010-04-13 12:50:19 +000025 Comparison between this and the supplied duration of time.</td></tr><tr valign="top"><td width="20%" align="right"><code>public boolean</code></td><td width="" align="left"><code><a href="#method_lt">lt</a>(org.eclipse.wst.xml.xpath2.processor.internal.types.AnyType arg
26 ,
jmoller3a919172011-05-18 23:01:47 +000027 org.eclipse.wst.xml.xpath2.api.DynamicContext context)</code><br>
dacarver647c7352009-08-27 01:37:31 +000028 &nbsp;&nbsp;&nbsp;&nbsp;
jmoller3a919172011-05-18 23:01:47 +000029 Comparison between this and the supplied duration of time.</td></tr><tr valign="top"><td width="20%" align="right"><code>public org.eclipse.wst.xml.xpath2.api.ResultSequence</code></td><td width="" align="left"><code><a href="#method_minus">minus</a>(org.eclipse.wst.xml.xpath2.api.ResultSequence arg)</code><br>
dacarver647c7352009-08-27 01:37:31 +000030 &nbsp;&nbsp;&nbsp;&nbsp;
31 Mathematical subtraction between this duration stored and the supplied
32 duration of time (of type XSYearMonthDuration)</td></tr><tr valign="top"><td width="20%" align="right"><code>public int</code></td><td width="" align="left"><code><a href="#method_monthValue">monthValue</a>()</code><br>
33 &nbsp;&nbsp;&nbsp;&nbsp;
34 Retrieves the duration of time stored as the number of months within it</td></tr><tr valign="top"><td width="20%" align="right"><code>public boolean</code></td><td width="" align="left"><code><a href="#method_negative">negative</a>()</code><br>
35 &nbsp;&nbsp;&nbsp;&nbsp;
36 Retrieves whether this duration represents a backward passage through
37 time</td></tr><tr valign="top"><td width="20%" align="right"><code>public static org.eclipse.wst.xml.xpath2.processor.internal.types.XSDuration</code></td><td width="" align="left"><code><a href="#method_parseYMDuration">parseYMDuration</a>(java.lang.String str)</code><br>
38 &nbsp;&nbsp;&nbsp;&nbsp;
39 Creates a new XSYearMonthDuration by parsing the supplied String
jmoller3a919172011-05-18 23:01:47 +000040 represented duration of time</td></tr><tr valign="top"><td width="20%" align="right"><code>public org.eclipse.wst.xml.xpath2.api.ResultSequence</code></td><td width="" align="left"><code><a href="#method_plus">plus</a>(org.eclipse.wst.xml.xpath2.api.ResultSequence arg)</code><br>
dacarver647c7352009-08-27 01:37:31 +000041 &nbsp;&nbsp;&nbsp;&nbsp;
42 Mathematical addition between this duration stored and the supplied
43 duration of time (of type XSYearMonthDuration)</td></tr><tr valign="top"><td width="20%" align="right"><code>public java.lang.String</code></td><td width="" align="left"><code><a href="#method_string_type">string_type</a>()</code><br>
44 &nbsp;&nbsp;&nbsp;&nbsp;
jmoller3a919172011-05-18 23:01:47 +000045 Retrieves the datatype's full pathname</td></tr><tr valign="top"><td width="20%" align="right"><code>public org.eclipse.wst.xml.xpath2.api.ResultSequence</code></td><td width="" align="left"><code><a href="#method_times">times</a>(org.eclipse.wst.xml.xpath2.api.ResultSequence arg)</code><br>
dacarver647c7352009-08-27 01:37:31 +000046 &nbsp;&nbsp;&nbsp;&nbsp;
47 Mathematical multiplication between this duration stored and the supplied
48 duration of time (of type XSYearMonthDuration)</td></tr><tr valign="top"><td width="20%" align="right"><code>public java.lang.String</code></td><td width="" align="left"><code><a href="#method_type_name">type_name</a>()</code><br>
49 &nbsp;&nbsp;&nbsp;&nbsp;
50 Retrives the datatype's name</td></tr></table><hr><table cols="2" width="100%" border="1"><tr colspan="2" width="100%" bgcolor="#CCCCFF" align="left"><td><h2>
51 Constructor Detail
52 </h2></td></tr></table><h2><a name="con_XSYearMonthDuration">XSYearMonthDuration</a></h2><p><code>public <strong>XSYearMonthDuration</strong>(int year
53 ,
54 int month
55 ,
56 boolean negative)</code></p><p>Initialises using the supplied parameters. If the number of months
57 supplied is more than 12, the number of years is adjusted accordingly.</p><hr><h2><a name="con_XSYearMonthDuration">XSYearMonthDuration</a></h2><p><code>public <strong>XSYearMonthDuration</strong>(int months)</code></p><p>Initialises to the given number of months</p><hr><h2><a name="con_XSYearMonthDuration">XSYearMonthDuration</a></h2><p><code>public <strong>XSYearMonthDuration</strong>()</code></p><p>Initialises to a duration of no time (0years and 0months)</p><hr><table cols="2" width="100%" border="1"><tr colspan="2" width="100%" bgcolor="#CCCCFF" align="left"><td><h2>
58 Methods Detail
jmoller3a919172011-05-18 23:01:47 +000059 </h2></td></tr></table><h2><a name="method_constructor">constructor</a></h2><p><code>public org.eclipse.wst.xml.xpath2.api.ResultSequence <strong>constructor</strong>(org.eclipse.wst.xml.xpath2.api.ResultSequence arg)</code></p><p>Creates a new ResultSequence consisting of the extractable time duration
60 from the supplied ResultSequence</p><h3>Parameters</h3><p><code>arg</code> - The ResultSequence from which to extract</p><h3>Returns</h3><p><code>org.eclipse.wst.xml.xpath2.api.ResultSequence</code> - New ResultSequence consisting of the time duration extracted</p><h3>Throws:</h3><p><code>org.eclipse.wst.xml.xpath2.processor.DynamicError</code></p><hr><h2><a name="method_div">div</a></h2><p><code>public org.eclipse.wst.xml.xpath2.api.ResultSequence <strong>div</strong>(org.eclipse.wst.xml.xpath2.api.ResultSequence arg)</code></p><p>Mathematical division between this duration stored and the supplied
61 duration of time (of type XSYearMonthDuration)</p><h3>Parameters</h3><p><code>arg</code> - The duration of time to divide by</p><h3>Returns</h3><p><code>org.eclipse.wst.xml.xpath2.api.ResultSequence</code> - New XSYearMonthDuration representing the resulting duration after the division</p><h3>Throws:</h3><p><code>org.eclipse.wst.xml.xpath2.processor.DynamicError</code></p><hr><h2><a name="method_eq">eq</a></h2><p><code>public boolean <strong>eq</strong>(org.eclipse.wst.xml.xpath2.processor.internal.types.AnyType arg
dacarver67d3b162010-04-13 12:50:19 +000062 ,
jmoller3a919172011-05-18 23:01:47 +000063 org.eclipse.wst.xml.xpath2.api.DynamicContext dynamicContext)</code></p><p>Equality comparison between this and the supplied duration of time.</p><h3>Parameters</h3><p><code>arg</code> - The duration of time to compare with</p><p><code>dynamicContext</code></p><h3>Returns</h3><p><code>boolean</code> - True if they both represent the duration of time. False otherwise</p><h3>Throws:</h3><p><code>org.eclipse.wst.xml.xpath2.processor.DynamicError</code></p><hr><h2><a name="method_getStringValue">getStringValue</a></h2><p><code>public java.lang.String <strong>getStringValue</strong>()</code></p><p>Retrieves a String representation of the duration of time stored</p><h3>Returns</h3><p><code>java.lang.String</code> - String representation of the duration of time stored</p><hr><h2><a name="method_getTypeDefinition">getTypeDefinition</a></h2><p><code>public org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinition <strong>getTypeDefinition</strong>()</code></p><p></p><h3>Returns</h3><p><code>org.eclipse.wst.xml.xpath2.api.typesystem.TypeDefinition</code></p><hr><h2><a name="method_gt">gt</a></h2><p><code>public boolean <strong>gt</strong>(org.eclipse.wst.xml.xpath2.processor.internal.types.AnyType arg
dacarver67d3b162010-04-13 12:50:19 +000064 ,
jmoller3a919172011-05-18 23:01:47 +000065 org.eclipse.wst.xml.xpath2.api.DynamicContext context)</code></p><p>Comparison between this and the supplied duration of time.</p><h3>Parameters</h3><p><code>arg</code> - The duration of time to compare with</p><p><code>context</code></p><h3>Returns</h3><p><code>boolean</code> - True if the supplied time represents a smaller duration than that stored. False otherwise</p><h3>Throws:</h3><p><code>org.eclipse.wst.xml.xpath2.processor.DynamicError</code></p><hr><h2><a name="method_lt">lt</a></h2><p><code>public boolean <strong>lt</strong>(org.eclipse.wst.xml.xpath2.processor.internal.types.AnyType arg
dacarver67d3b162010-04-13 12:50:19 +000066 ,
jmoller3a919172011-05-18 23:01:47 +000067 org.eclipse.wst.xml.xpath2.api.DynamicContext context)</code></p><p>Comparison between this and the supplied duration of time.</p><h3>Parameters</h3><p><code>arg</code> - The duration of time to compare with</p><p><code>context</code></p><h3>Returns</h3><p><code>boolean</code> - True if the supplied time represents a larger duration than that stored. False otherwise</p><h3>Throws:</h3><p><code>org.eclipse.wst.xml.xpath2.processor.DynamicError</code></p><hr><h2><a name="method_minus">minus</a></h2><p><code>public org.eclipse.wst.xml.xpath2.api.ResultSequence <strong>minus</strong>(org.eclipse.wst.xml.xpath2.api.ResultSequence arg)</code></p><p>Mathematical subtraction between this duration stored and the supplied
68 duration of time (of type XSYearMonthDuration)</p><h3>Parameters</h3><p><code>arg</code> - The duration of time to subtract</p><h3>Returns</h3><p><code>org.eclipse.wst.xml.xpath2.api.ResultSequence</code> - New XSYearMonthDuration representing the resulting duration after the subtraction</p><h3>Throws:</h3><p><code>org.eclipse.wst.xml.xpath2.processor.DynamicError</code></p><hr><h2><a name="method_monthValue">monthValue</a></h2><p><code>public int <strong>monthValue</strong>()</code></p><p>Retrieves the duration of time stored as the number of months within it</p><h3>Returns</h3><p><code>int</code> - Number of months making up this duration of time</p><hr><h2><a name="method_negative">negative</a></h2><p><code>public boolean <strong>negative</strong>()</code></p><p>Retrieves whether this duration represents a backward passage through
dacarver647c7352009-08-27 01:37:31 +000069 time</p><h3>Returns</h3><p><code>boolean</code> - True if this duration represents a backward passage through time. False otherwise</p><hr><h2><a name="method_parseYMDuration">parseYMDuration</a></h2><p><code>public org.eclipse.wst.xml.xpath2.processor.internal.types.XSDuration <strong>parseYMDuration</strong>(java.lang.String str)</code></p><p>Creates a new XSYearMonthDuration by parsing the supplied String
jmoller3a919172011-05-18 23:01:47 +000070 represented duration of time</p><h3>Parameters</h3><p><code>str</code> - String represented duration of time</p><h3>Returns</h3><p><code>org.eclipse.wst.xml.xpath2.processor.internal.types.XSDuration</code> - New XSYearMonthDuration representing the duration of time supplied</p><hr><h2><a name="method_plus">plus</a></h2><p><code>public org.eclipse.wst.xml.xpath2.api.ResultSequence <strong>plus</strong>(org.eclipse.wst.xml.xpath2.api.ResultSequence arg)</code></p><p>Mathematical addition between this duration stored and the supplied
71 duration of time (of type XSYearMonthDuration)</p><h3>Parameters</h3><p><code>arg</code> - The duration of time to add</p><h3>Returns</h3><p><code>org.eclipse.wst.xml.xpath2.api.ResultSequence</code> - New XSYearMonthDuration representing the resulting duration after the addition</p><h3>Throws:</h3><p><code>org.eclipse.wst.xml.xpath2.processor.DynamicError</code></p><hr><h2><a name="method_string_type">string_type</a></h2><p><code>public java.lang.String <strong>string_type</strong>()</code></p><p>Retrieves the datatype's full pathname</p><h3>Returns</h3><p><code>java.lang.String</code> - "xs:yearMonthDuration" which is the datatype's full pathname</p><hr><h2><a name="method_times">times</a></h2><p><code>public org.eclipse.wst.xml.xpath2.api.ResultSequence <strong>times</strong>(org.eclipse.wst.xml.xpath2.api.ResultSequence arg)</code></p><p>Mathematical multiplication between this duration stored and the supplied
72 duration of time (of type XSYearMonthDuration)</p><h3>Parameters</h3><p><code>arg</code> - The duration of time to multiply by</p><h3>Returns</h3><p><code>org.eclipse.wst.xml.xpath2.api.ResultSequence</code> - New XSYearMonthDuration representing the resulting duration after the multiplication</p><h3>Throws:</h3><p><code>org.eclipse.wst.xml.xpath2.processor.DynamicError</code></p><hr><h2><a name="method_type_name">type_name</a></h2><p><code>public java.lang.String <strong>type_name</strong>()</code></p><p>Retrives the datatype's name</p><h3>Returns</h3><p><code>java.lang.String</code> - "yearMonthDuration" which is the datatype's name</p><hr></body></html>