Notation conventions for methods - Revision history

Dme: /* Constructors */

2015-08-14T17:51:21Z

Constructors

← Older revision		Revision as of 17:51, 14 August 2015
Line 86:		Line 86:
	==Constructors==		==Constructors==
	Methods that produce a new object instance of their class are known generally as "constructors." These include the <var>[[Object variables#Using New or other Constructors\|New]]</var> method		Methods that produce a new object instance of their class are known generally as "constructors." These include the <var>[[Object variables#Using New or other Constructors\|New]]</var> method
	in Janus system classes (a non-shared method whose method type is <var>Constructor</var>), and the shared method [[Object variables#Virtual ~~Constructor methods~~\|virtual constructors]] (mentioned in [[#Shared methods\|"Shared methods"]] above).		in Janus system classes (a non-shared method whose method type is <var>Constructor</var>), and the shared method [[Object variables#Virtual constructors\|virtual constructors]] (mentioned in [[#Shared methods\|"Shared methods"]] above).

	All constructors are recognizable by the <code>[%(classname):]</code> notation preceding the method name in the method syntax. As for a shared method, the class name in the syntax indicates both of the following:		All constructors are recognizable by the <code>[%(classname):]</code> notation preceding the method name in the method syntax. As for a shared method, the class name in the syntax indicates both of the following:

Dme: /* Constructors */

2015-08-14T17:49:11Z

Constructors

← Older revision		Revision as of 17:49, 14 August 2015
Line 106:		Line 106:

	Although the preceding examples of constructor invocation use assignment statements, you can invoke a constructor with or without a method object or explicit class specification in other contexts that allow its class to be determined, for example as an argument in another method. This class-identifying requirement is '''not''' met, for example, in this statement, which is ''invalid'': <code>Print New</code>		Although the preceding examples of constructor invocation use assignment statements, you can invoke a constructor with or without a method object or explicit class specification in other contexts that allow its class to be determined, for example as an argument in another method. This class-identifying requirement is '''not''' met, for example, in this statement, which is ''invalid'': <code>Print New</code>

			The use of constructors is discussed in [[Object_variables#Creating object instances\|"Creating object instances"]].

	==Exceptions==		==Exceptions==

Dme: /* Constructors */

2015-08-14T17:34:02Z

Constructors

← Older revision		Revision as of 17:34, 14 August 2015
Line 86:		Line 86:
	==Constructors==		==Constructors==
	Methods that produce a new object instance of their class are known generally as "constructors." These include the <var>[[Object variables#Using New or other Constructors\|New]]</var> method		Methods that produce a new object instance of their class are known generally as "constructors." These include the <var>[[Object variables#Using New or other Constructors\|New]]</var> method
	in Janus system classes (a non-shared method whose method type is <var>Constructor</var>), and the shared method [[Object variables#Virtual Constructor methods\|virtual constructors]] (mentioned above).		in Janus system classes (a non-shared method whose method type is <var>Constructor</var>), and the shared method [[Object variables#Virtual Constructor methods\|virtual constructors]] (mentioned in [[#Shared methods\|"Shared methods"]] above).

	All constructors are recognizable by the <code>[%(classname):]</code> notation preceding the method name in the method syntax. As for a shared method, the class name in the syntax indicates both of the following:		All constructors are recognizable by the <code>[%(classname):]</code> notation preceding the method name in the method syntax. As for a shared method, the class name in the syntax indicates both of the following:

JAL: typo

2015-02-25T18:58:44Z

typo

← Older revision		Revision as of 18:58, 25 February 2015
Line 146:		Line 146:
	==See also==		==See also==
	<ul>		<ul>
	<li>[[XmlDoc API#Conventions and terminology for XmlDoc API ~~methds~~\|Conventions and terminology for XmlDoc API ~~methds~~]]		<li>[[XmlDoc API#Conventions and terminology for XmlDoc API methods\|Conventions and terminology for XmlDoc API methods]]
	</ul>		</ul>

Dme at 21:46, 22 January 2015

2015-01-22T21:46:58Z

← Older revision		Revision as of 21:46, 22 January 2015
Line 27:		Line 27:

	==Mixed case==		==Mixed case==
	Method names are in mixed case with initial and internal capital letters. <var class="product">SOUL</var> keywords and variable name references are also in mixed case. This mixed-case convention is adhered to in text and syntax; it is not strictly adhered to in code examples. For more information about mixed-case <var class="product">User Language</var>, see [[Mixed-case ~~User Language~~]].		Method names are in mixed case with initial and internal capital letters. <var class="product">SOUL</var> keywords and variable name references are also in mixed case. This mixed-case convention is adhered to in text and syntax; it is not strictly adhered to in code examples. For more information about mixed-case <var class="product">User Language</var>, see [[Mixed-case SOUL]].
	<p></p>		<p></p>

JAL: /* Exceptions */

2014-03-03T22:10:22Z

Exceptions

← Older revision		Revision as of 22:10, 3 March 2014
Line 120:		Line 120:
	<li>The method object in the invocation is <var>Null</var>, which causes <var>New</var> to be invoked [[Classes and Objects#The Auto keyword on object declarations\|implicitly]]. </li>		<li>The method object in the invocation is <var>Null</var>, which causes <var>New</var> to be invoked [[Classes and Objects#The Auto keyword on object declarations\|implicitly]]. </li>

	<li>The implicit <var>New</var> call throws the ~~excption~~. </li>		<li>The implicit <var>New</var> call throws the exception. </li>
	</ul>		</ul>

Line 130:		Line 130:
	</p>		</p>

	The <var>Run</var> invocation above can be wrapped in a <var>Try</var> block, but if the application needs to anticipate ~~and~~ this type of implicit exception, it might be better to use an explicit instantiation of the object:		The <var>Run</var> invocation above can be wrapped in a <var>Try</var> block, but if the application needs to anticipate this type of implicit exception, it might be better to use an explicit instantiation of the object:
	<p class="code">begin		<p class="code">begin
	%daem is object daemon		%daem is object daemon

Dme: /* Exceptions */

2014-03-02T22:51:52Z

Exceptions

← Older revision		Revision as of 22:51, 2 March 2014
Line 118:		Line 118:
	<li>The syntax of its class's <var>New</var> method includes one or more exceptions (true for several classes). </li>		<li>The syntax of its class's <var>New</var> method includes one or more exceptions (true for several classes). </li>

	<li>The method object in the invocation is <var>Null</var>, which causes <var>New</var> to be invoked ([[Classes and Objects#The Auto keyword on object declarations\|implicitly]]. </li>		<li>The method object in the invocation is <var>Null</var>, which causes <var>New</var> to be invoked [[Classes and Objects#The Auto keyword on object declarations\|implicitly]]. </li>

	<li>The implicit <var>New</var> call throws the excption. </li>		<li>The implicit <var>New</var> call throws the excption. </li>
	</ul>		</ul>

	For example, the <var>[[Run (Daemon function)\|Run]]</var> function in the following example can cause a <var>MaxDaemExceeded]]</var> exception:		For example, the <var>[[Run (Daemon function)\|Run]]</var> function in the following example can cause a <var>MaxDaemExceeded</var> exception:
	<p class="code">begin		<p class="code">begin
	%daem is object daemon auto new		%daem is object daemon auto new

Dme: /* Exceptions */

2014-03-02T22:47:07Z

Exceptions

← Older revision		Revision as of 22:47, 2 March 2014
Line 118:		Line 118:
	<li>The syntax of its class's <var>New</var> method includes one or more exceptions (true for several classes). </li>		<li>The syntax of its class's <var>New</var> method includes one or more exceptions (true for several classes). </li>

	<li>The method object in the invocation is <var>Null</var>, which causes ~~the~~ <var>New</var> to be ([[Classes and Objects#The Auto keyword on object declarations\|~~invoked~~ implicitly]]. </li>		<li>The method object in the invocation is <var>Null</var>, which causes <var>New</var> to be invoked ([[Classes and Objects#The Auto keyword on object declarations\|implicitly]]. </li>

	<li>The implicit <var>New</var> call throws the excption. </li>		<li>The implicit <var>New</var> call throws the excption. </li>

Dme: /* Exceptions */

2014-03-02T22:45:47Z

Exceptions

← Older revision		Revision as of 22:45, 2 March 2014
Line 114:		Line 114:
	<ul>		<ul>

	<li>The method is not a <var>[[#Shared methods\|Shared]] method.		<li>The method is not a <var>[[#Shared methods\|Shared]]</var> method.

	<li>The syntax of its class's <var>New</var> method includes one or more exceptions (true for several classes). </li>		<li>The syntax of its class's <var>New</var> method includes one or more exceptions (true for several classes). </li>

Dme at 22:44, 2 March 2014

2014-03-02T22:44:24Z

@@ Line 6: / Line 6: @@
 <li>Special characters (square brackets, hyphens) that you do not specify because they are part of the syntax structure, not the method content
 </ul>
-For example, here is the syntax for the <var>Patch</var> method of the <var>Stringlist</var> class:
+For example, here is the syntax for the <var>FindNextItem</var> method of the <var>Arraylist</var> class:
-{{Template:Stringlist:Patch syntax}}
+{{Template:Arraylist:FindNextItem syntax}}
-The <var>Patch</var> method does the following:
+The <var>FindNextItem</var> method does the following:
 <ul>
 <li>Accepts two arguments (the second of which is [[#Optional arguments|optional]] &mdash; as indicated by the square brackets (<tt>[]</tt>) &mdash; and also [[#Named arguments|named]] &mdash; as indicated by the name and equal sign (<tt>=</tt>).
-<li>Takes as input the <var>Stringlist</var> that is the [[Methods#Comparing methods to complex subroutines|method object]] (<var class="term">sl</var>).
+<li>Takes as input the <var>Arraylist</var> that is the [[Methods#Comparing methods to complex subroutines|method object]] (<var class="term">al</var>).
-<li>Returns the updated version of that <var>Stringlist</var> to a <var>Stringlist</var> object variable (<var class="term">%updList</var>).
+<li>May throw the <var>ItemNotFound</var> [[#Exceptions|exception]].
 </ul>
@@ Line 104: / Line 106: @@
 Although the preceding examples of constructor invocation use assignment statements, you can invoke a constructor with or without a method object or explicit class specification in other contexts that allow its class to be determined, for example as an argument in another method. This class-identifying requirement is '''not''' met, for example, in this statement, which is ''invalid'': <code>Print New</code>
 ==See also==