Author: schor
Date: Wed Jul 25 20:32:04 2018
New Revision: 1836670
URL: http://svn.apache.org/viewvc?rev=1836670&view=rev
Log:
[UIMA-5845] make select get/single have consistent return or throw for
get/single when nothing is found, based on setting of nullOK(). Clarify
javadocs
Modified:
uima/uv3/uimaj-v3/trunk/uima-docbook-v3-users-guide/src/docbook/uv3.select.xml
Modified:
uima/uv3/uimaj-v3/trunk/uima-docbook-v3-users-guide/src/docbook/uv3.select.xml
URL:
http://svn.apache.org/viewvc/uima/uv3/uimaj-v3/trunk/uima-docbook-v3-users-guide/src/docbook/uv3.select.xml?rev=1836670&r1=1836669&r2=1836670&view=diff
==============================================================================
---
uima/uv3/uimaj-v3/trunk/uima-docbook-v3-users-guide/src/docbook/uv3.select.xml
(original)
+++
uima/uv3/uimaj-v3/trunk/uima-docbook-v3-users-guide/src/docbook/uv3.select.xml
Wed Jul 25 20:32:04 2018
@@ -334,7 +334,7 @@ FSIterator<Token> token_iterator =
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis role="strong">nullOk</emphasis></term>
+ <term><emphasis role="strong">mullOK</emphasis></term>
<listitem>
<para>changes the behavior for the terminal_form actions
<code>get(...) and single(...)</code>, which would otherwise
throw an exception if a null result happened.
@@ -774,11 +774,11 @@ startAt(begin, end, shifted) // same as
<varlistentry>
<term><emphasis role="strong">get</emphasis></term>
<listitem>
- <para>If no argument is specified, then returns the first item.
If nullOk(false) is configured,
- then if the result is null, an exception will be thrown.
+ <para>If no argument is specified, then returns the first item.
If there is no item, then
+ an exception is thrown unless <code>nullOK</code> is set.
</para>
<para>If any positioning arguments are specified, then this
returns the item at that position unless
- there is no item at that position, in which case it throws an
exception unless <code>nullOk</code> is set.
+ there is no item at that position, in which case it throws an
exception unless <code>mullOK</code> is set.
</para>
</listitem>
</varlistentry>
