InvalidSortSpecification class - Revision history

JAL at 21:14, 18 November 2014

2014-11-18T21:14:29Z

← Older revision		Revision as of 21:14, 18 November 2014
Line 6:		Line 6:

	This exception class has no properties.		This exception class has no properties.
	The class's only method is the <var>[[New (InvalidSortSpecification constructor)\|New]]</var> constructor, which you would typically use with a <var class="product">~~User Language~~</var> <var>[[Throw statement\|Throw]]</var> statement to produce an <var>InvalidSortSpecification</var> exception yourself. For example:		The class's only method is the <var>[[New (InvalidSortSpecification constructor)\|New]]</var> constructor, which you would typically use with a <var class="product">SOUL</var> <var>[[Throw statement\|Throw]]</var> statement to produce an <var>InvalidSortSpecification</var> exception yourself. For example:
	<p class="code">throw %(invalidSortSpecification):new		<p class="code">throw %(invalidSortSpecification):new
	</p>		</p>
Line 25:		Line 25:
	be correct in all circumstances, and if it is not, you want a request cancellation. So you do <b>not</b> provide a <code>try.../catch</code> block.		be correct in all circumstances, and if it is not, you want a request cancellation. So you do <b>not</b> provide a <code>try.../catch</code> block.

	The <var>InvalidSortSpecification</var> class is available as of <var class="product">[[~~Category:System exception classes~~]]</var> version 7.9.		The <var>InvalidSortSpecification</var> class is available as of <var class="product">[[Sirius Mods]]</var> version 7.9.

JAL at 22:07, 26 November 2012

2012-11-26T22:07:54Z

New page

__NOTOC__
An <var>InvalidSortSpecification</var> exception indicates that the first argument provided to either the
<var>[[Sort (Stringlist subroutine)|Sort]]</var> or
<var>[[SortNew (Stringlist function)|SortNew]]</var> method (in the <var>Stringlist</var> class) is not a valid sort specification.

This exception class has no properties.
The class's only method is the <var>[[New (InvalidSortSpecification constructor)|New]]</var> constructor, which you would typically use with a <var class="product">User Language</var> <var>[[Throw statement|Throw]]</var> statement to produce an <var>InvalidSortSpecification</var> exception yourself. For example:
<p class="code">throw %(invalidSortSpecification):new
</p>

Remember that you catch an exception with the <var>[[Catch statement|Catch]]</var> statement; if an exception condition occurs outside a
<var>Catch</var> for it, the request is cancelled.

Although the <var>InvalidSortSpecification</var> is rarely used, one possibly appropriate occasion might be a sort specification entered (at least in
part) by an end user. In this case, you could provide a <code>try.../catch invalidSortSpecification</code> block like the following:
<p class="code">%sortSpec = $read('Enter sort specification')
[[Exceptions#Try and Catch|try]] %strlist:sort(%sortSpec)
catch invalidSortSpecification
Print 'Invalid ...'
...
end try
</p>
In most cases, however, a sort specification is explicitly coded in the <var class="product">User Language</var> request (for example, rather than <code>%sortSpec = $read...</code> as above, something like <code>%sortSpec = '1,10,CH,A'</code>). You expect such a sort specification to
be correct in all circumstances, and if it is not, you want a request cancellation. So you do <b>not</b> provide a <code>try.../catch</code> block.

The <var>InvalidSortSpecification</var> class is available as of <var class="product">[[Category:System exception classes]]</var> version 7.9.

==The InvalidSortSpecification methods==
{{Template:List of InvalidSortSpecification methods}}

The methods in the class are described in the subsections that follow. In addition:
<ul>
<li>[[Notation conventions for methods|"Notation conventions for methods"]] has information
about the conventions followed.
<li>[[InvalidSortSpecification methods syntax|"InvalidSortSpecification methods syntax"]] is a single page that contains the syntax diagrams of all the methods in the class.
</ul>

==New constructor==
{{Template:InvalidSortSpecification:New subtitle}}

This <var>Constructor</var> generates an instance of an <var>InvalidSortSpecification</var> exception. The <var>New</var> method format follows:

===Syntax===
{{Template:InvalidSortSpecification:New syntax}}

====Syntax terms====
<table class="syntaxTable">
<tr><th>%invalidSortSpecification</th>
<td>An <var>InvalidSortSpecification</var> %variable which will refer to the newly created object.
</td></tr>

<tr><th><var>[%(InvalidSortSpecification):]</var></th><td>The class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors|Constructor]]</var>. <var>New</var> can also be invoked via an <var>InvalidSortSpecification</var> object variable.</td></tr>
</table>

[[Category:System exception classes]]

JAL2: /* The InvalidSortSpecification methods */

2012-08-07T18:01:30Z

The InvalidSortSpecification methods

← Older revision		Revision as of 18:01, 7 August 2012
Line 46:		Line 46:
	<h3>Syntax</h3>		<h3>Syntax</h3>
	{{Template:InvalidSortSpecification:New syntax}}		{{Template:InvalidSortSpecification:New syntax}}

	<h4>Syntax terms</h4>		<h4>Syntax terms</h4>
	<table class="syntaxTable">		<table class="syntaxTable">
Line 51:		Line 52:
	<td>An <var>InvalidSortSpecification</var> %variable which will refer to the newly created object.		<td>An <var>InvalidSortSpecification</var> %variable which will refer to the newly created object.
	</td></tr>		</td></tr>
	<tr><th><var>%(InvalidSortSpecification)</var></th><td>The class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors\|Constructor]]</var>. <var>New</var> can also be invoked via an <var>InvalidSortSpecification</var> object variable.</td></tr>
			<tr><th><var>[%(InvalidSortSpecification):]</var></th><td>The class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors\|Constructor]]</var>. <var>New</var> can also be invoked via an <var>InvalidSortSpecification</var> object variable.</td></tr>
	</table>		</table>


	[[Category:System exception classes]]		[[Category:System exception classes]]

JAL2 at 18:57, 8 August 2011

2011-08-08T18:57:53Z

← Older revision		Revision as of 18:57, 8 August 2011
Line 6:		Line 6:

	This exception class has no properties.		This exception class has no properties.
	The class's only method is the <var>[[New (InvalidSortSpecification constructor)\|New]]</var> constructor, which you would typically use with a <var class="product">User Language</var> <var>[[Throw statement\|Throw]]</var> statement to produce an <var>InvalidSortSpecification</var> exception. For example:		The class's only method is the <var>[[New (InvalidSortSpecification constructor)\|New]]</var> constructor, which you would typically use with a <var class="product">User Language</var> <var>[[Throw statement\|Throw]]</var> statement to produce an <var>InvalidSortSpecification</var> exception yourself. For example:
	<p class="code">throw %(invalidSortSpecification):new		<p class="code">throw %(invalidSortSpecification):new
	</p>		</p>

JAL2 at 18:51, 8 August 2011

2011-08-08T18:51:00Z

← Older revision		Revision as of 18:51, 8 August 2011
Line 10:		Line 10:
	</p>		</p>

	Remember that ~~catching~~ an exception ~~is done~~ with the <var>[[Catch statement\|Catch]]</var> statement; if an exception condition occurs outside a		Remember that you catch an exception with the <var>[[Catch statement\|Catch]]</var> statement; if an exception condition occurs outside a
	<var>Catch</var> for it, the request is cancelled.		<var>Catch</var> for it, the request is cancelled.

JAL2 at 21:01, 27 July 2011

2011-07-27T21:01:17Z

← Older revision		Revision as of 21:01, 27 July 2011
Line 42:		Line 42:
	{{Template:InvalidSortSpecification:New subtitle}}		{{Template:InvalidSortSpecification:New subtitle}}

	This ~~[[Notation conventions for methods\|callable]] constructor~~ generates an instance of an <var>InvalidSortSpecification</var> exception. The <var>New</var> ~~constructor~~ format follows:		This <var>Constructor</var> generates an instance of an <var>InvalidSortSpecification</var> exception. The <var>New</var> method format follows:

	<h3>Syntax</h3>		<h3>Syntax</h3>
Line 51:		Line 51:
	<td>An <var>InvalidSortSpecification</var> %variable which will refer to the newly created object.		<td>An <var>InvalidSortSpecification</var> %variable which will refer to the newly created object.
	</td></tr>		</td></tr>
	<tr><th><var>%(InvalidSortSpecification)</var></th><td>The class name in parentheses denotes a ~~shared method~~. <var>New</var> can also be invoked via an <var>InvalidSortSpecification</var> object variable.</td></tr>		<tr><th><var>%(InvalidSortSpecification)</var></th><td>The class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors\|Constructor]]</var>. <var>New</var> can also be invoked via an <var>InvalidSortSpecification</var> object variable.</td></tr>
	</table>		</table>


	[[Category:System exception classes]]		[[Category:System exception classes]]

JAL2 at 23:21, 9 June 2011

2011-06-09T23:21:54Z

← Older revision		Revision as of 23:21, 9 June 2011
Line 13:		Line 13:
	<var>Catch</var> for it, the request is cancelled.		<var>Catch</var> for it, the request is cancelled.

	~~Actually,~~ the <var>InvalidSortSpecification</var> is rarely used~~. One possible~~ occasion ~~for using it would~~ be a sort specification entered (at least in		Although the <var>InvalidSortSpecification</var> is rarely used, one possibly appropriate occasion might be a sort specification entered (at least in
	part) by an end user. In this case, a <code>try.../catch invalidSortSpecification</code> block ~~might be appropriate~~:		part) by an end user. In this case, you could provide a <code>try.../catch invalidSortSpecification</code> block like the following:
	<p class="code">%sortSpec = $read('Enter sort specification')		<p class="code">%sortSpec = $read('Enter sort specification')
	[[Try statement\|try]] %strlist:sort(%sortSpec)		[[Try statement\|try]] %strlist:sort(%sortSpec)
Line 22:		Line 22:
	end try		end try
	</p>		</p>
	In most cases, however, a sort specification is explicitly coded in the <var>User Language</var> request (for example, rather than <code>%sortSpec = $read...</code> as above, something like <code>%sortSpec = '1,10,CH,A'</code>). ~~Such~~ a sort specification ~~should~~		In most cases, however, a sort specification is explicitly coded in the <var>User Language</var> request (for example, rather than <code>%sortSpec = $read...</code> as above, something like <code>%sortSpec = '1,10,CH,A'</code>). You expect such a sort specification to
	be correct in all circumstances, and if it is not, request cancellation (<b>not</b> a <code>try.../catch</code> block~~) is the appropriate action~~.		be correct in all circumstances, and if it is not, you want a request cancellation. So you do <b>not</b> provide a <code>try.../catch</code> block.

	The <var>InvalidSortSpecification</var> class is available as of <var class="product">[[Category:System exception classes]]</var> version 7.9.		The <var>InvalidSortSpecification</var> class is available as of <var class="product">[[Category:System exception classes]]</var> version 7.9.

JAL2: /* The InvalidSortSpecification methods */

2011-06-09T21:36:52Z

The InvalidSortSpecification methods

← Older revision		Revision as of 21:36, 9 June 2011
Line 44:		Line 44:
	This [[Notation conventions for methods\|callable]] constructor generates an instance of an <var>InvalidSortSpecification</var> exception. The <var>New</var> constructor format follows:		This [[Notation conventions for methods\|callable]] constructor generates an instance of an <var>InvalidSortSpecification</var> exception. The <var>New</var> constructor format follows:

	<h4>Syntax</h4>		<h3>Syntax</h3>
	{{Template:InvalidSortSpecification:New syntax}}		{{Template:InvalidSortSpecification:New syntax}}
	<h4>Syntax terms</h4>		<h4>Syntax terms</h4>

JAL2: /* New constructor */

2011-06-09T21:35:41Z

New constructor

← Older revision		Revision as of 21:35, 9 June 2011
Line 39:		Line 39:


	~~===~~New constructor~~===~~		<h2>New constructor</h2>
	{{Template:InvalidSortSpecification:New subtitle}}		{{Template:InvalidSortSpecification:New subtitle}}

JAL2: /* New constructor */

2011-06-09T21:26:12Z

New constructor

← Older revision		Revision as of 21:26, 9 June 2011
Line 44:		Line 44:
	This [[Notation conventions for methods\|callable]] constructor generates an instance of an <var>InvalidSortSpecification</var> exception. The <var>New</var> constructor format follows:		This [[Notation conventions for methods\|callable]] constructor generates an instance of an <var>InvalidSortSpecification</var> exception. The <var>New</var> constructor format follows:

	<h3>Syntax</h3>		<h4>Syntax</h4>
	{{Template:InvalidSortSpecification:New syntax}}		{{Template:InvalidSortSpecification:New syntax}}
	<h4>Syntax terms</h4>		<h4>Syntax terms</h4>