InvalidBitNumber class - Revision history

JAL: add link to exception example

2016-03-15T19:39:46Z

add link to exception example

← Older revision		Revision as of 19:39, 15 March 2016
Line 1:		Line 1:
	<!-- InvalidBitNumber class -->		<!-- InvalidBitNumber class -->
	__NOTOC__		__NOTOC__
	The <var>InvalidBitNumber</var> exception class indicates that a bit number request by a bit manipulation function was incorrect, either negative, greater than the number of bits in the string, or non-integral. <var>InvalidBitNumber</var> was introduced in Model 204 version 7.5.		The <var>InvalidBitNumber</var> exception class indicates that a bit number request by a bit manipulation function was incorrect, either negative, greater than the number of bits in the string, or non-integral. <var>InvalidBitNumber</var> was introduced in Model 204 version 7.5.

	To produce a <var>InvalidBitNumber</var> exception for yourself, you typically use a <var class="product">User Language</var> <var>[[Exceptions#Throwing exceptions\|Throw]]</var> statement with an <var>InvalidBitNumber</var> <var>[[~~New_~~(~~InvalidBitNumber_constructor~~)\|New]]</var> constructor. For example, the following statement throws an <var>InvalidBitNumber</var> exception:		To produce a <var>InvalidBitNumber</var> exception for yourself, you typically use a <var class="product">User Language</var> <var>[[Exceptions#Throwing exceptions\|Throw]]</var> statement with an <var>InvalidBitNumber</var> <var>[[New (InvalidBitNumber constructor)\|New]]</var> constructor. For example, the following statement throws an <var>InvalidBitNumber</var> exception:
	<p class="code">throw %(invalidBitNumber):new		<p class="code">throw %(invalidBitNumber):new
	</p>		</p>

			For an example of how you might use an exception in your own code, see this [[InvalidValue class\|InvalidValue exception example]].

	==The InvalidBitNumber methods==		==The InvalidBitNumber methods==
Line 13:		Line 14:
	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~~\|"Notation conventions for methods"~~]] has information		<li>[[Notation conventions for methods]] has information
	about the conventions followed.		about the conventions followed. </li>
	<li>[[InvalidBitNumber methods syntax~~\|"InvalidBitNumber methods syntax"~~]] is a single page that contains the syntax diagrams of all the methods in the class.
			<li>[[InvalidBitNumber methods syntax]] is a single page that contains the syntax diagrams of all the methods in the class. </li>
	</ul>		</ul>

Line 26:		Line 28:

	====Syntax terms====		====Syntax terms====
	<table ~~class="syntaxTable"~~>		<table>
	<tr><th><var class="term">%number</var></th><td>The invalid bit number that was requested and so caused the exception to be thrown</td></tr>		<tr><th><var class="term">%number</var></th>
			<td>The invalid bit number that was requested and so caused the exception to be thrown</td></tr>

	<tr><th>%invalidBitNumber</th>		<tr><th>%invalidBitNumber</th>
	<td>A reference to an instance of a <var>InvalidBitNumber</var> object.		<td>A reference to an instance of a <var>InvalidBitNumber</var> object.
Line 36:		Line 40:
	{{Template:InvalidBitNumber:New subtitle}}		{{Template:InvalidBitNumber:New subtitle}}

	This <var>Constructor</var> generates an instance of an <var>[[~~InvalidBitNumber_class~~\|InvalidBitNumber]]</var> exception. The <var>New</var> method format is as follows:		This <var>Constructor</var> generates an instance of an <var>[[InvalidBitNumber class\|InvalidBitNumber]]</var> exception. The <var>New</var> method format is as follows:

	===Syntax===		===Syntax===
Line 42:		Line 46:

	====Syntax terms====		====Syntax terms====
	<table ~~class="syntaxTable"~~>		<table>

	<tr><th>%invalidBitNumber</th>		<tr><th>%invalidBitNumber</th>
Line 48:		Line 52:
	</td></tr>		</td></tr>

	<tr><th nowrap="nowrap"><var>[%(InvalidBitNumber):]</var></th><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 a <var>InvalidBitNumber</var> <var>Constructor</var>.</td></tr>		<tr><th nowrap="nowrap"><var>[%(InvalidBitNumber):]</var></th>
	<tr><th><var class="term">number</var></th><td>The bit number that will be returned by the BitNumber property.</td></tr>		<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 a <var>InvalidBitNumber</var> <var>Constructor</var>.</td></tr>

			<tr><th><var class="term">number</var></th>
			<td>The bit number that will be returned by the BitNumber property.</td></tr>
	</table>		</table>

	===Usage notes===		===Usage notes===
	<ul>		<ul>
	<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>:		<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">%invalidBitNumber = new		<p class="code">%invalidBitNumber = new

Line 62:		Line 69:
	</p>		</p>
	</ul>		</ul>

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

ELowell at 22:14, 29 October 2014

2014-10-29T22:14:31Z

← Older revision		Revision as of 22:14, 29 October 2014
Line 1:		Line 1:
	<!-- InvalidBitNumber class -->		<!-- InvalidBitNumber class -->
	__NOTOC__		__NOTOC__
	The <var>InvalidBitNumber</var> exception class indicates that a bit number request by a bit manipulation function was incorrect, either negative, greater than the number of bits in the string, or non-integral.		The <var>InvalidBitNumber</var> exception class indicates that a bit number request by a bit manipulation function was incorrect, either negative, greater than the number of bits in the string, or non-integral. <var>InvalidBitNumber</var> was introduced in Model 204 version 7.5.

	To produce a <var>InvalidBitNumber</var> exception for yourself, you typically use a <var class="product">User Language</var> <var>[[Exceptions#Throwing exceptions\|Throw]]</var> statement with an <var>InvalidBitNumber</var> <var>[[New_(InvalidBitNumber_constructor)\|New]]</var> constructor. For example, the following statement throws an <var>InvalidBitNumber</var> exception:		To produce a <var>InvalidBitNumber</var> exception for yourself, you typically use a <var class="product">User Language</var> <var>[[Exceptions#Throwing exceptions\|Throw]]</var> statement with an <var>InvalidBitNumber</var> <var>[[New_(InvalidBitNumber_constructor)\|New]]</var> constructor. For example, the following statement throws an <var>InvalidBitNumber</var> exception:

Admin: /* BitNumber property */

2013-03-21T23:20:32Z

BitNumber property

← Older revision		Revision as of 23:20, 21 March 2013
Line 20:		Line 20:
	==BitNumber property==		==BitNumber property==
	{{Template:InvalidBitNumber:BitNumber subtitle}}		{{Template:InvalidBitNumber:BitNumber subtitle}}
			This <var>property</var> returns the invalid bit number that was requested and so caused the exception to be thrown.

			===Syntax===
			{{Template:InvalidBitNumber:BitNumber syntax}}

			====Syntax terms====
			<table class="syntaxTable">
			<tr><th><var class="term">%number</var></th><td>The invalid bit number that was requested and so caused the exception to be thrown</td></tr>
			<tr><th>%invalidBitNumber</th>
			<td>A reference to an instance of a <var>InvalidBitNumber</var> object.
			</td></tr>
			</table>

	==New constructor==		==New constructor==

Admin: /* New constructor */

2013-03-21T23:17:21Z

New constructor

← Older revision		Revision as of 23:17, 21 March 2013
Line 17:		Line 17:
	<li>[[InvalidBitNumber methods syntax\|"InvalidBitNumber methods syntax"]] is a single page that contains the syntax diagrams of all the methods in the class.		<li>[[InvalidBitNumber methods syntax\|"InvalidBitNumber methods syntax"]] is a single page that contains the syntax diagrams of all the methods in the class.
	</ul>		</ul>

			==BitNumber property==
			{{Template:InvalidBitNumber:BitNumber subtitle}}



	==New constructor==		==New constructor==

Admin: /* The InvalidBitNumber methods */

2013-03-21T23:14:19Z

The InvalidBitNumber methods

← Older revision		Revision as of 23:14, 21 March 2013
Line 9:		Line 9:

	==The InvalidBitNumber methods==		==The InvalidBitNumber methods==
	{{Template:List of ~~InvalidTranslateTable~~ methods}}		{{Template:List of InvalidBitNumber methods}}

	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:
Line 17:		Line 17:
	<li>[[InvalidBitNumber methods syntax\|"InvalidBitNumber methods syntax"]] is a single page that contains the syntax diagrams of all the methods in the class.		<li>[[InvalidBitNumber methods syntax\|"InvalidBitNumber methods syntax"]] is a single page that contains the syntax diagrams of all the methods in the class.
	</ul>		</ul>


	==New constructor==		==New constructor==

Admin: /* Syntax terms */

2013-03-21T23:13:32Z

Syntax terms

← Older revision		Revision as of 23:13, 21 March 2013
Line 35:		Line 35:

	<tr><th nowrap="nowrap"><var>[%(InvalidBitNumber):]</var></th><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 a <var>InvalidBitNumber</var> <var>Constructor</var>.</td></tr>		<tr><th nowrap="nowrap"><var>[%(InvalidBitNumber):]</var></th><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 a <var>InvalidBitNumber</var> <var>Constructor</var>.</td></tr>
			<tr><th><var class="term">number</var></th><td>The bit number that will be returned by the BitNumber property.</td></tr>
	</table>		</table>

Admin: Created page with " NOTOC The `InvalidBitNumber` exception class indicates that a bit number request by a bit manipulation function was incorrect, eit..."

2013-03-21T23:10:15Z

Created page with " __NOTOC__ The <var>InvalidBitNumber</var> exception class indicates that a bit number request by a bit manipulation function was incorrect, eit..."

New page

__NOTOC__
The <var>InvalidBitNumber</var> exception class indicates that a bit number request by a bit manipulation function was incorrect, either negative, greater than the number of bits in the string, or non-integral.

To produce a <var>InvalidBitNumber</var> exception for yourself, you typically use a <var class="product">User Language</var> <var>[[Exceptions#Throwing exceptions|Throw]]</var> statement with an <var>InvalidBitNumber</var> <var>[[New_(InvalidBitNumber_constructor)|New]]</var> constructor. For example, the following statement throws an <var>InvalidBitNumber</var> exception:
<p class="code">throw %(invalidBitNumber):new
</p>

==The InvalidBitNumber methods==
{{Template:List of InvalidTranslateTable 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>[[InvalidBitNumber methods syntax|"InvalidBitNumber methods syntax"]] is a single page that contains the syntax diagrams of all the methods in the class.
</ul>

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

This <var>Constructor</var> generates an instance of an <var>[[InvalidBitNumber_class|InvalidBitNumber]]</var> exception. The <var>New</var> method format is as follows:

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

====Syntax terms====
<table class="syntaxTable">

<tr><th>%invalidBitNumber</th>
<td>A reference to an instance of a <var>InvalidBitNumber</var> object.
</td></tr>

<tr><th nowrap="nowrap"><var>[%(InvalidBitNumber):]</var></th><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 a <var>InvalidBitNumber</var> <var>Constructor</var>.</td></tr>
</table>

===Usage notes===
<ul>
<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">%invalidBitNumber = new

%invalidBitNumber = %(InvalidBitNumber):new

%invalidBitNumber = %invalidBitNumber:new
</p>
</ul>
[[Category:System exception classes]]