| dacarver | 647c735 | 2009-08-27 01:37:31 +0000 | [diff] [blame] | 1 | <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> |
| 3 | extends 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 | , |
| 7 | 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.processor.ResultSequence</code></td><td width="" align="left"><code><a href="#method_constructor">constructor</a>(org.eclipse.wst.xml.xpath2.processor.ResultSequence arg)</code><br> |
| 8 | |
| 9 | Creates a new ResultSequence consisting of the extractable time duration |
| 10 | from the supplied ResultSequence</td></tr><tr valign="top"><td width="20%" align="right"><code>public org.eclipse.wst.xml.xpath2.processor.ResultSequence</code></td><td width="" align="left"><code><a href="#method_div">div</a>(org.eclipse.wst.xml.xpath2.processor.ResultSequence arg)</code><br> |
| 11 | |
| 12 | Mathematical division between this duration stored and the supplied |
| dacarver | 67d3b16 | 2010-04-13 12:50:19 +0000 | [diff] [blame] | 13 | 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 | , |
| 15 | org.eclipse.wst.xml.xpath2.processor.DynamicContext context)</code><br> |
| dacarver | 647c735 | 2009-08-27 01:37:31 +0000 | [diff] [blame] | 16 | |
| dacarver | 67d3b16 | 2010-04-13 12:50:19 +0000 | [diff] [blame] | 17 | Equality 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_gt">gt</a>(org.eclipse.wst.xml.xpath2.processor.internal.types.AnyType arg |
| 18 | , |
| 19 | org.eclipse.wst.xml.xpath2.processor.DynamicContext context)</code><br> |
| dacarver | 647c735 | 2009-08-27 01:37:31 +0000 | [diff] [blame] | 20 | |
| dacarver | 67d3b16 | 2010-04-13 12:50:19 +0000 | [diff] [blame] | 21 | 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 |
| 22 | , |
| 23 | org.eclipse.wst.xml.xpath2.processor.DynamicContext context)</code><br> |
| dacarver | 647c735 | 2009-08-27 01:37:31 +0000 | [diff] [blame] | 24 | |
| 25 | 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.processor.ResultSequence</code></td><td width="" align="left"><code><a href="#method_minus">minus</a>(org.eclipse.wst.xml.xpath2.processor.ResultSequence arg)</code><br> |
| 26 | |
| 27 | Mathematical subtraction between this duration stored and the supplied |
| 28 | 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> |
| 29 | |
| 30 | 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> |
| 31 | |
| 32 | Retrieves whether this duration represents a backward passage through |
| 33 | 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> |
| 34 | |
| 35 | Creates a new XSYearMonthDuration by parsing the supplied String |
| 36 | represented duration of time</td></tr><tr valign="top"><td width="20%" align="right"><code>public org.eclipse.wst.xml.xpath2.processor.ResultSequence</code></td><td width="" align="left"><code><a href="#method_plus">plus</a>(org.eclipse.wst.xml.xpath2.processor.ResultSequence arg)</code><br> |
| 37 | |
| 38 | Mathematical addition between this duration stored and the supplied |
| 39 | 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> |
| 40 | |
| 41 | Retrieves the datatype's full pathname</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_value">string_value</a>()</code><br> |
| 42 | |
| 43 | 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.processor.ResultSequence</code></td><td width="" align="left"><code><a href="#method_times">times</a>(org.eclipse.wst.xml.xpath2.processor.ResultSequence arg)</code><br> |
| 44 | |
| 45 | Mathematical multiplication between this duration stored and the supplied |
| 46 | 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> |
| 47 | |
| 48 | 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> |
| 49 | Constructor Detail |
| 50 | </h2></td></tr></table><h2><a name="con_XSYearMonthDuration">XSYearMonthDuration</a></h2><p><code>public <strong>XSYearMonthDuration</strong>(int year |
| 51 | , |
| 52 | int month |
| 53 | , |
| 54 | boolean negative)</code></p><p>Initialises using the supplied parameters. If the number of months |
| 55 | 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> |
| 56 | Methods Detail |
| 57 | </h2></td></tr></table><h2><a name="method_constructor">constructor</a></h2><p><code>public org.eclipse.wst.xml.xpath2.processor.ResultSequence <strong>constructor</strong>(org.eclipse.wst.xml.xpath2.processor.ResultSequence arg)</code></p><p>Creates a new ResultSequence consisting of the extractable time duration |
| 58 | 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.processor.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.processor.ResultSequence <strong>div</strong>(org.eclipse.wst.xml.xpath2.processor.ResultSequence arg)</code></p><p>Mathematical division between this duration stored and the supplied |
| dacarver | 67d3b16 | 2010-04-13 12:50:19 +0000 | [diff] [blame] | 59 | 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.processor.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 |
| 60 | , |
| 61 | org.eclipse.wst.xml.xpath2.processor.DynamicContext context)</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>context</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_gt">gt</a></h2><p><code>public boolean <strong>gt</strong>(org.eclipse.wst.xml.xpath2.processor.internal.types.AnyType arg |
| 62 | , |
| 63 | org.eclipse.wst.xml.xpath2.processor.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 |
| 64 | , |
| 65 | org.eclipse.wst.xml.xpath2.processor.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.processor.ResultSequence <strong>minus</strong>(org.eclipse.wst.xml.xpath2.processor.ResultSequence arg)</code></p><p>Mathematical subtraction between this duration stored and the supplied |
| dacarver | 647c735 | 2009-08-27 01:37:31 +0000 | [diff] [blame] | 66 | 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.processor.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 |
| 67 | 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 |
| 68 | 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.processor.ResultSequence <strong>plus</strong>(org.eclipse.wst.xml.xpath2.processor.ResultSequence arg)</code></p><p>Mathematical addition between this duration stored and the supplied |
| 69 | 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.processor.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_string_value">string_value</a></h2><p><code>public java.lang.String <strong>string_value</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_times">times</a></h2><p><code>public org.eclipse.wst.xml.xpath2.processor.ResultSequence <strong>times</strong>(org.eclipse.wst.xml.xpath2.processor.ResultSequence arg)</code></p><p>Mathematical multiplication between this duration stored and the supplied |
| 70 | 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.processor.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> |