How to convert an Optional into a Stream?

Question

I want to prepend a stream with an Optional. Since Stream.concat can only concatinate Streams I have this question:

How do I convert an Optional<T> into a Stream<T>?

Example:

Optional<String> optional = Optional.of("Hello");
Stream<String> texts = optional.stream(); // not working

See http://stackoverflow.com/questions/22725537/using-java-8s-optional-with-streamflatmap — Alexis C., Nov 26 '15 at 15:54
That question indeed answers this one, but it presents a more complex example. I think this one is worth keeping for the simple case. — Didier L, Nov 27 '15 at 10:48

score 149 · Answer 1 · edited Nov 13 '20 at 14:35

149

If restricted with Java-8, you can do this:

Stream<String> texts = optional.map(Stream::of).orElseGet(Stream::empty);

edited Nov 13 '20 at 14:35

Naman

27,789
26
218
353

answered Nov 26 '15 at 15:52

slartidan

20,403
15
83
131

4

I upvoted this because Java 9 has some non-backward compatible changes for some projects in their current state. Some projects, such as [lombok](https://github.com/rzwitserloot/lombok/issues/985), are part of core corporate artifacts that are slow to be changed. – Niko Oct 05 '17 at 20:05
If by any chance your optional happens to contain a `List` instead of a single `String` object, you just need to replace `Stream::of` with `List::stream`. The same applies to any other type of collection. You can also just use `Collection::stream`. Else you will get a `Stream>` which is probably _not_ what you wanted. – walen Oct 04 '19 at 11:55
@walen the question is to convert an `Optional` to `Stream` if the T is `List`, so be it. The answer stands correct still. What you might be looking for is flattening the collection. Aside, you are already on the wrong path if you have ended up using `Optional>`. – Naman Nov 13 '20 at 14:34
@Naman No need to justify the answer — I didn't say it wasn't correct. I just gave a tip on how to apply this solution to an `Optional` containing a `List`, which is a scenario some people might encounter. – walen Nov 14 '20 at 15:56

score 83 · Accepted Answer · edited Apr 28 '18 at 07:17

83

In Java-9 the missing stream() method is added, so this code works:

Stream<String> texts = optional.stream();

See JDK-8050820. Download Java-9 here.

edited Apr 28 '18 at 07:17

slartidan

20,403
15
83
131

answered Nov 27 '15 at 01:54

Tagir Valeev

97,161
19
222
334

score 8 · Answer 3 · answered Nov 26 '15 at 15:54

8

You can do:

Stream<String> texts = optional.isPresent() ? Stream.of(optional.get()) : Stream.empty();

answered Nov 26 '15 at 15:54

Konstantin Yovkov

62,134
8
100
147

14

I'm not a big fan of `isPresent`, it feels like a legacy method to me and reminds me of the times before Java8. But thanks for providing an alternative solution. – slartidan Nov 26 '15 at 15:56
Less fluent than the `map().orElseGet()` approach but probably slightly more efficient. – augurar Jul 23 '18 at 01:53

score 8 · Answer 4 · answered Nov 14 '17 at 15:10

8

I can recommend Guava's Streams.stream(optional) method if you are not on Java 9. A simple example:

Streams.stream(Optional.of("Hello"))

Also possible to static import Streams.stream, so you can just write

stream(Optional.of("Hello"))

answered Nov 14 '17 at 15:10

Utku Özdemir

7,390
2
52
49

score 1 · Answer 5 · answered Mar 22 '18 at 04:33

If you're on an older version of Java (lookin' at you, Android) and are using the aNNiMON Lightweight Stream API, you can do something along the lines of the following:

    final List<String> flintstones = new ArrayList<String>(){{
        add("Fred");
        add("Wilma");
        add("Pebbles");
    }};

    final List<String> another = Optional.ofNullable(flintstones)
            .map(Stream::of)
            .orElseGet(Stream::empty)
            .toList();

This example just makes a copy of the list.

JustAnotherCoder · Answer 6 · 2021-02-07T21:30:52.660

1

It can depend of how you want to convert empty optional to stream element. If you want to interpret it as "nothing" (or "no element"):

Stream<String> texts = optional.stream(); // since JDK 9
Stream<String> texts = optional.map(Stream::of).orElseGet(Stream::empty); // JDK 8

But if you want to interpret it as null:

Stream<String> texts = Stream.of(optional.oreElse(null));

edited Feb 07 '21 at 21:30

answered Feb 07 '21 at 20:20

JustAnotherCoder

621
7
13

score 0 · Answer 7 · answered Mar 29 '18 at 10:06

0

A nice library from one of my ex collegues is Streamify. A lot of collectors, creating streams from practicly everything.

https://github.com/sourcy/streamify

Creating a stream form an optional in streamify:

Streamify.stream(optional)

answered Mar 29 '18 at 10:06

Gábor Lipták

9,646
2
59
113

How to convert an Optional into a Stream?

7 Answers7

Linked

Related