From 80c0596733f58297242765f432d72565b3fc9a0b Mon Sep 17 00:00:00 2001 From: David Mischke Date: Sat, 21 Jul 2018 14:09:32 +0200 Subject: [PATCH] improve Source.range docs #24933 --- .../paradox/stream/operators/Source/range.md | 12 ++--- .../java/jdocs/stream/operators/Source.java | 45 +++++++++++++++++++ .../scala/docs/stream/operators/Source.java | 22 --------- 3 files changed, 52 insertions(+), 27 deletions(-) create mode 100644 akka-docs/src/test/java/jdocs/stream/operators/Source.java delete mode 100644 akka-docs/src/test/scala/docs/stream/operators/Source.java diff --git a/akka-docs/src/main/paradox/stream/operators/Source/range.md b/akka-docs/src/main/paradox/stream/operators/Source/range.md index 40908b132f..8030445934 100644 --- a/akka-docs/src/main/paradox/stream/operators/Source/range.md +++ b/akka-docs/src/main/paradox/stream/operators/Source/range.md @@ -12,10 +12,6 @@ Emit each integer in a range, with an option to take bigger steps than 1. version="$akka.version$" } -## Signature - -@@signature [Source.scala]($akka$/akka-stream/src/main/scala/akka/stream/javadsl/Source.scala) { #range } - ## Description @@ -32,7 +28,13 @@ Emit each integer in a range, with an option to take bigger steps than 1. In Sca ## Examples +Define the range of integers. + Java -: @@snip [Source.java]($akka$/akka-docs/src/test/scala/docs/stream/operators/Source.java) { #imports #range } +: @@snip [Source.java]($akka$/akka-docs/src/test/java/jdocs/stream/operators/Source.java) { #imports #range } +Print out the stream of integers. + +Java +: @@snip [Source.java]($akka$/akka-docs/src/test/java/jdocs/stream/operators/Source.java) { #run-range} diff --git a/akka-docs/src/test/java/jdocs/stream/operators/Source.java b/akka-docs/src/test/java/jdocs/stream/operators/Source.java new file mode 100644 index 0000000000..addcc70d80 --- /dev/null +++ b/akka-docs/src/test/java/jdocs/stream/operators/Source.java @@ -0,0 +1,45 @@ +/** + * Copyright (C) 2018 Lightbend Inc. + */ +package docs.stream.operators; + +//#imports +import akka.NotUsed; +import akka.stream.javadsl.Source; + +//#imports + +import akka.actor.ActorSystem; +import akka.stream.ActorMaterializer; +import akka.stream.Materializer; + +public class Source { + + public static void main(String[] args) { + rangeExample(); + } + + static void rangeExample() { + + final ActorSystem system = ActorSystem.create("Source"); + final Materializer materializer = ActorMaterializer.create(system); + + //#range + Source source = Source.range(1, 100); + + //#range + + //#range + Source sourceStepFive = Source.range(1, 100, 5); + + //#range + + //#range + Source sourceStepNegative = Source.range(100, 1, -1); + //#range + + //#run-range + source.runForeach(i -> System.out.println(i), materializer); + //#run-range + +} \ No newline at end of file diff --git a/akka-docs/src/test/scala/docs/stream/operators/Source.java b/akka-docs/src/test/scala/docs/stream/operators/Source.java deleted file mode 100644 index 474902da76..0000000000 --- a/akka-docs/src/test/scala/docs/stream/operators/Source.java +++ /dev/null @@ -1,22 +0,0 @@ -/** - * Copyright (C) 2018 Lightbend Inc. - */ - -//#imports -import akka.stream.javadsl.Source -//#imports - -package docs.stream.operators - -public class Source { - - def rangeExample() = { - //#range - final Source source = Source.range(1, 100); - //#range - - //#range - final Source source = Source.range(1, 100, 5); - //#range - } -} \ No newline at end of file