This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.
<!DOCTYPE html>
<htmlxmlns="http://www.w3.org/1999/xhtml"><head><title>Models (infer.Nullsafe.Models)</title><linkrel="stylesheet"href="../../../odoc.css"/><metacharset="utf-8"/><metaname="generator"content="odoc 1.5.1"/><metaname="viewport"content="width=device-width,initial-scale=1.0"/><scriptsrc="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><divclass="content"><header><nav><ahref="../index.html">Up</a>–<ahref="../../index.html">infer</a>»<ahref="../index.html">Nullsafe</a>» Models</nav><h1>Module <code>Nullsafe.Models</code></h1></header><aside><p>Methods dealing with specific knowledge about code in important third libraries, standard libraries, etc</p></aside><dl><dtclass="spec value"id="val-get_modelled_annotated_signature"><ahref="#val-get_modelled_annotated_signature"class="anchor"></a><code><spanclass="keyword">val</span> get_modelled_annotated_signature : <span>is_callee_in_trust_list:bool</span><span>-></span><ahref="../../IR/Tenv/index.html#type-t">IR.Tenv.t</a><span>-></span><ahref="../../IR/ProcAttributes/index.html#type-t">IR.ProcAttributes.t</a><span>-></span><ahref="../AnnotatedSignature/index.html#type-t">AnnotatedSignature.t</a></code></dt><dd><p>Return the annotated signature of the procedure, taking into account models. External models take precedence over internal ones.</p></dd></dl><dl><dtclass="spec value"id="val-is_check_not_null"><ahref="#val-is_check_not_null"class="anchor"></a><code><spanclass="keyword">val</span> is_check_not_null : <ahref="../../IR/Procname/Java/index.html#type-t">IR.Procname.Java.t</a><span>-></span> bool</code></dt><dd><p>Check if the procedure is one of the known methods asserting nullability of the object. Nullsafe should understand that both the argument and return value are non-nullable after the call.</p></dd></dl><dl><dtclass="spec value"id="val-get_check_not_null_parameter"><ahref="#val-get_check_not_null_parameter"class="anchor"></a><code><spanclass="keyword">val</span> get_check_not_null_parameter : <ahref="../../IR/Procname/Java/index.html#type-t">IR.Procname.Java.t</a><span>-></span><span>int option</span></code></dt><dd><p>Parameter number (starting from 1) for a procedure known to produce a non-nullable assertion. <code>None</code> if the function is not known to be an aseertion OR the parameter number is not known</p></dd></dl><dl><dtclass="spec value"id="val-is_check_state"><ahref="#val-is_check_state"class="anchor"></a><code><spanclass="keyword">val</span> is_check_state : <ahref="../../IR/Procname/Java/index.html#type-t">IR.Procname.Java.t</a><span>-></span> bool</code></dt><dd><p>Check if the procedure is one of the known Preconditions.checkState.</p></dd></dl><dl><dtclass="spec value"id="val-is_check_argument"><ahref="#val-is_check_argument"class="anchor"></a><code><spanclass="keyword">val</span> is_check_argument : <ahref="../../IR/Procname/Java/index.html#type-t">IR.Procname.Java.t</a><span>-></span> bool</code></dt><dd><p>Check if the procedure is one of the known Preconditions.checkArgument.</p></dd></dl><dl><dtclass="spec value"id="val-is_noreturn"><ahref="#val-is_noreturn"class="anchor"></a><code><spanclass="keyword">val</span> is_noreturn : <ahref="../../IR/Procname/Java/index.html#type-t">IR.Procname.Java.t</a><span>-></span> bool</code></dt><dd><p>Check if the procedure does not return.</p></dd></dl><dl><dtclass="spec value"id="val-is_true_on_null"><ahref="#val-is_true_on_null"class="anchor"></a><code><spanclass="keyword">val</span> is_true_on_null : <ahref="../../IR/Procname/Java/index.html#type-t">IR.Procname.Java.t</a><span>-></span> bool</code></dt><dd><p>Check if the procedure returns true on null.</p></dd></dl><dl><dtclass="spec value"id="val-is_false_on_null"><ahref="#val-is_false_on_null"class="anchor"></a><code><spanclass="keyword">val</span> is_false_on_null : <ahref="../../IR/Procname/Java/index.html#type-t">IR.Procname.Java.t</a><span>-></span> bool</code></dt><dd><p>Check if the procedure returns false on null.</p></dd></dl><dl><dtclass="spec value"id="val-is_containsKey"><ahref="#val-is_containsKey"class="anchor"></a><code><spanclass="keyword">val</span> is_containsKey : <ahref="../../IR/Procname/Java/index.html#type-t">IR.Procname.Java.t</a><span>-></span> bool</code></dt><dd><p>Check if the procedure is Map.containsKey().</p></dd></dl><dl><dtclass="spec value"id="val-is_mapPut"><ahref="#val-is_mapPut"class="anchor"></a><code><spanclass="keyword">val</span> is_mapPut : <ahref="../../IR/Procname/Java/index.html#type-t">IR.Procname.Java.t</a><span>-></span> bool</code></dt><dd><p>Check if the procedure is Map.put().</p></dd></dl><dl><dtclass="spec value"id="val-find_nonnullable_alternative"><ahref="#val-find_nonnullable_alternative"class="anchor"></a><code><spanclass="keyword">val</span> find_nonnullable_alternative : <ahref="../../IR/Procname/Java/index.html#type-t">IR.Procname.Java.t</a><span>-></span><span><ahref="../ModelTables/index.html#type-nonnull_alternative_method">ModelTables.nonnull_alternative_method</a> option</span></code></dt><dd><p>Check if a (nullable) method has a non-nullable alternative: A method that does the same as <code>proc_name</code> but asserts the result is not null before returning to the caller.</p></dd></dl><dl><dtclass="spec value"id="val-is_field_nonnullable"><ahref="#val-is_field_nonnullable"class="anchor"></a><code><spanclass="keyword">val</span> is_field_nonnullable : <ahref="../../IR/Fieldname/index.html#type-t">IR.Fieldname.t</a><span>-></span><span>bool option</span></code></dt><dd><p>Check if a given field has known nullability: true = nonnull, false = null</p></dd></dl></div></body></html>
