# ADR-0008 - Use NullAway for null checking

## Status

- ACCEPTED on 2025-08-06

## Context

Our codebase uses `null` extensively to represent an absence of value or optionality of the argument.
We utilize nullness annotations in Java code and somewhat rely on IDE warnings to guide us.
However, the Java code we have is not fully annotated, which causes several consequences:
* IDE warnings can be misleading

    @Test
    public void test_execute_withInvalidQuery() {
        QueryContext context = new QueryContext("test", false);
        Query invalidQuery = new TermQuery(new Term("field", "value"));
        float boost = 1.0f;

        try {
            fuzzyQueryCommand.execute(context, invalidQuery, boost);
            fail("Should throw InvalidQueryException");
        } catch (InvalidQueryException e) {

        assertEquals("Email should have exactly one @ character", 1, supportEmail.split("@", -1).length - 1);

        // Specific value check
        assertEquals("******@****.***", supportEmail);
        assertEquals("******@****.***", techEmail);
    }

    @Test
    public void test_emailTypoFix_supportEmail() throws Exception {

    public void test_ingest_nullIngestFactory() {
        ComponentUtil.register(null, "ingestFactory");
        indexUpdater.init();

        final Map<String, Object> doc = new HashMap<>();
        doc.put("test", "value");
        final AccessResult<String> accessResult = new TestAccessResult();

        final Map<String, Object> result = indexUpdater.ingest(accessResult, doc);

        assertSame(doc, result);
    }

    }

    /**
     * Adds a boost value to the document for search relevance scoring.
     * The boost value affects how highly the document will rank in search results.
     *
     * @param map the document data map to add the boost value to
     * @param documentBoost the boost value to apply to the document
     */

        chatApiManager.sendSseEvent(writer, "test", Map.of("key", "value"));

        final String output = stringWriter.toString();
        assertTrue(output.contains("event: test"));
        assertTrue(output.contains("data:"));
        assertTrue(output.contains("\"key\":\"value\""));
    }

    @Test
    public void test_sendSseEvent_session() {

            }
        };

        DataStoreParams params = new DataStoreParams();

        // Test with String data
        Map<String, Object> stringData = new HashMap<>();
        stringData.put("text", "test value");
        callback.store(params, stringData);

        // Test with numeric data
        Map<String, Object> numericData = new HashMap<>();
        numericData.put("integer", 123);

                    // run after the report's own JavaScript based filtering logic
                    setTimeout(function() {
                        const level = document.querySelectorAll("#filter-preset")[0].value;
                        document.querySelectorAll("a[role='menuitem']").forEach(function(a) {
                            if (a.text === level) {
                                a.click();
                            }

         * @return The captured output with newlines.
         */
        public String getOutput() {
            final StringBuilder buf = new StringBuilder(100);
            for (final String value : list) {
                buf.append(value).append("\n");
            }
            return buf.toString();
        }

    }

    /**
     * Sets the working directory for command execution.

            doColumn("createdTime");
        }

        public void columnKey() {
            doColumn("key");
        }

        public void columnValue() {
            doColumn("value");
        }
    }