org.checkerframework.checker.nullness

Class SystemGetPropertyHandler

java.lang.Object

org.checkerframework.checker.nullness.SystemGetPropertyHandler

public class SystemGetPropertyHandler
extends Object

Utility class for handling System.getProperty(String) and related invocations.

The result of the method call is assumed to be non-null if the argument is a literal key that is guaranteed to be present in the system properties (according to the documentation of System.getProperty(String)), as in System.getProperties("line.separator").

Field Summary

Fields

Modifier and Type	Field and Description
static Collection<String>	predefinedSystemProperties System properties that are defined at startup on every JVM.

Constructor Summary

Constructors

Constructor and Description
SystemGetPropertyHandler(ProcessingEnvironment env, NullnessAnnotatedTypeFactory factory, boolean permitClearProperty) Creates a SystemGetPropertyHandler.

Method Summary

Modifier and Type	Method and Description
void	handle(MethodInvocationTree tree, AnnotatedTypeMirror.AnnotatedExecutableType method) Apply rules regarding System.getProperty and related methods.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

predefinedSystemProperties

public static final Collection<String> predefinedSystemProperties

System properties that are defined at startup on every JVM.

This list is from the Javadoc of System.getProperties, for Java 17.

Constructor Detail

SystemGetPropertyHandler

public SystemGetPropertyHandler(ProcessingEnvironment env,
                                NullnessAnnotatedTypeFactory factory,
                                boolean permitClearProperty)

Creates a SystemGetPropertyHandler.

Parameters:

env - the processing environment

factory - the factory for constructing and looking up types

permitClearProperty - if true, client code may clear system properties, and this object does nothing

Method Detail

handle

public void handle(MethodInvocationTree tree,
                   AnnotatedTypeMirror.AnnotatedExecutableType method)

Apply rules regarding System.getProperty and related methods.

Parameters:

tree - a method invocation

method - the method being invoked