InvalidDateString class: Difference between revisions
Jump to navigation
Jump to search
m (link repair) |
m (add link to exception example) |
||
| Line 3: | Line 3: | ||
The <var>InvalidDateString</var> exception class describes an exception associated with a string that contains a date that is not valid, for any of [[Datetime string formats#Valid datetimes|several reasons]]. This exception class has no properties. It is simply a notification that a date string is invalid. | The <var>InvalidDateString</var> exception class describes an exception associated with a string that contains a date that is not valid, for any of [[Datetime string formats#Valid datetimes|several reasons]]. This exception class has no properties. It is simply a notification that a date string is invalid. | ||
To produce an <var>InvalidDateString</var> exception yourself, you typically use a <var class="product">User Language</var> <var>[[Exceptions#Using the Throw statement|Throw]]</var> statement with an <var>InvalidDateString</var> <var>[[ | To produce an <var>InvalidDateString</var> exception yourself, you typically use a <var class="product">User Language</var> <var>[[Exceptions#Using the Throw statement|Throw]]</var> statement with an <var>InvalidDateString</var> <var>[[New (InvalidDateString_constructor)|New]]</var> constructor. This statement must be issued from within a method, and it can only be caught by the code that calls the method. For example, the following statement throws an <var>InvalidDateString</var> exception: | ||
<p class="code">throw %(invalidDateString):new | <p class="code">throw %(invalidDateString):new | ||
</p> | </p> | ||
| Line 10: | Line 10: | ||
<var>Catch</var> for it, the request is cancelled. | <var>Catch</var> for it, the request is cancelled. | ||
For an example of how you might use an exception in your own code, see this [[InvalidValue class|InvalidValue exception example]]. | |||
The <var>InvalidDateString</var> class is available as of <var class="product">[[Sirius Mods]]</var> version 7.9. | The <var>InvalidDateString</var> class is available as of <var class="product">[[Sirius Mods]]</var> version 7.9. | ||
| Line 17: | Line 19: | ||
The methods in the class are described in the subsections that follow. In addition: | The methods in the class are described in the subsections that follow. In addition: | ||
<ul> | <ul> | ||
<li>[[Notation conventions for methods | <li>[[Notation conventions for methods]] has information | ||
about the conventions followed. | about the conventions followed. </li> | ||
<li>[[InvalidDateString methods syntax | |||
<li>[[InvalidDateString methods syntax]] is a single page that contains the syntax diagrams of all the methods in the class. </li> | |||
</ul> | </ul> | ||
| Line 26: | Line 29: | ||
{{Template:InvalidDateString:New subtitle}} | {{Template:InvalidDateString:New subtitle}} | ||
This <var>Constructor</var> generates an instance of an <var>[[ | This <var>Constructor</var> generates an instance of an <var>[[InvalidDateString class|InvalidDateString]]</var> exception. The <var>New</var> method format follows: | ||
===Syntax=== | ===Syntax=== | ||
{{Template:InvalidDateString:New syntax}} | {{Template:InvalidDateString:New syntax}} | ||
====Syntax terms==== | ====Syntax terms==== | ||
<table | <table> | ||
<tr><th>%invalidValue</th> | <tr><th>%invalidValue</th> | ||
<td>A reference to an instance of an <var>InvalidDateString</var> object. </td></tr> | <td>A reference to an instance of an <var>InvalidDateString</var> object. </td></tr> | ||
<tr><th><var>[%(InvalidDateString):]</var></th> | <tr><th><var>[%(InvalidDateString):]</var></th> | ||
<td>The class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors|Constructor]]</var>. See [[#Usage notes| | <td>The class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors|Constructor]]</var>. See [[#Usage notes|Usage notes]], below, for more information about invoking an <var>InvalidDateString</var> <var>Constructor</var>.</td></tr> | ||
</table> | </table> | ||
===Usage notes=== | ===Usage notes=== | ||
<ul> | <ul> | ||
<li>As described in [[Object variables#Using New or other Constructors| | <li>As described in [[Object variables#Using New or other Constructors|Using New or other Constructors]], <var>New</var> can be invoked with no object, with an explicit class name, or with an object variable in the class, even if that object is <var>Null</var>: | ||
<p class="code">%invalidDate = new | |||
%invalidDate = %(InvalidDateString):new | %invalidDate = %(InvalidDateString):new | ||
| Line 47: | Line 53: | ||
</p> | </p> | ||
</ul> | </ul> | ||
[[Category:System exception classes]] | [[Category:System exception classes]] | ||
Latest revision as of 19:36, 15 March 2016
The InvalidDateString exception class describes an exception associated with a string that contains a date that is not valid, for any of several reasons. This exception class has no properties. It is simply a notification that a date string is invalid.
To produce an InvalidDateString exception yourself, you typically use a User Language Throw statement with an InvalidDateString New constructor. This statement must be issued from within a method, and it can only be caught by the code that calls the method. For example, the following statement throws an InvalidDateString exception:
throw %(invalidDateString):new
Remember that you catch an exception with the Catch statement; if an exception condition occurs outside a Catch for it, the request is cancelled.
For an example of how you might use an exception in your own code, see this InvalidValue exception example.
The InvalidDateString class is available as of Sirius Mods version 7.9.
The InvalidDateString methods
The following are the available InvalidDateString class methods.
| Method | Description |
|---|---|
| New | Create a new InvalidDateString object |
The methods in the class are described in the subsections that follow. In addition:
- Notation conventions for methods has information about the conventions followed.
- InvalidDateString methods syntax is a single page that contains the syntax diagrams of all the methods in the class.
New constructor
Create a new InvalidDateString object (InvalidDateString class)
[Introduced in Sirius Mods 7.9]
This Constructor generates an instance of an InvalidDateString exception. The New method format follows:
Syntax
%invalidDateString = [%(InvalidDateString):]New
Syntax terms
| %invalidValue | A reference to an instance of an InvalidDateString object. |
|---|---|
| [%(InvalidDateString):] | The class name in parentheses denotes a Constructor. See Usage notes, below, for more information about invoking an InvalidDateString Constructor. |
Usage notes
- As described in Using New or other Constructors, New can be invoked with no object, with an explicit class name, or with an object variable in the class, even if that object is Null:
%invalidDate = new %invalidDate = %(InvalidDateString):new %invalidDate = %invalidDate:new