xref: /aosp_15_r20/external/aws-sdk-java-v2/docs/design/UseOfOptional.md (revision 8a52c7834d808308836a99fc2a6e0ed8db339086)
1**Design:** Convention, **Status:** [Accepted](README.md)
2
3## Use of Optional
4
5This page describes a general guideline for the use of
6`java.util.Optional` in the AWS SDK for Java 2.x.
7
8- `Optional` MUST NOT be used under any circumstances when the result will never be null.
9- For return types,
10  - `Optional` SHOULD be used when it is not obvious to a caller whether a
11  result will be null, e.g, `public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)`in [SdkResponse.java](https://github.com/aws/aws-sdk-java-v2/blob/aa161c564c580ced4a0381d3ed7d4d13120916fc/core/sdk-core/src/main/java/software/amazon/awssdk/core/SdkResponse.java#L59-L61)
12  - `Optional` MUST NOT be used for "getters" in generated service model classes such as service Builders or POJOs.
13- For member variables: `Optional` SHOULD NOT be used, e.g., `private final Optional<String> field;`
14- For method parameters: `Optional` MUST NOT be used, e.g., `private void test(Optional<String> value)`
15
16
17References:
18
19- http://blog.joda.org/2015/08/java-se-8-optional-pragmatic-approach.html
20