rename akka-docs dir to docs (#62)

This commit is contained in:
PJ Fanning 2022-12-02 10:49:40 +01:00 committed by GitHub
parent 13dce0ec69
commit 708da8caec
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1029 changed files with 2033 additions and 2039 deletions

View file

@ -0,0 +1,69 @@
/*
* Copyright (C) 2019-2022 Lightbend Inc. <https://www.lightbend.com>
*/
package jdocs.stream.operators.source;
//#imports
import java.util.concurrent.Flow.Subscriber;
import java.util.concurrent.Flow.Publisher;
import org.apache.pekko.NotUsed;
import org.apache.pekko.stream.javadsl.Source;
import org.apache.pekko.stream.javadsl.JavaFlowSupport;
//#imports
import org.apache.commons.lang.NotImplementedException;
public interface AsSubscriber {
// We are 'faking' the JavaFlowSupport API here so we can include the signature as a snippet in the API,
// because we're not publishing those (jdk9+) classes in our API docs yet.
static class JavaFlowSupport {
public static final class Source {
public
// #api
static <T> akka.stream.javadsl.Source<T, Subscriber<T>> asSubscriber()
// #api
{
return akka.stream.javadsl.JavaFlowSupport.Source.<T>asSubscriber();
}
}
}
static class Row {
public String getField(String fieldName) {
throw new NotImplementedException();
}
}
static class DatabaseClient {
Publisher<Row> fetchRows() {
throw new NotImplementedException();
}
}
DatabaseClient databaseClient = null;
// #example
class Example {
Source<Row, NotUsed> rowSource =
JavaFlowSupport.Source.<Row>asSubscriber()
.mapMaterializedValue(
subscriber -> {
// For each materialization, fetch the rows from the database:
Publisher<Row> rows = databaseClient.fetchRows();
rows.subscribe(subscriber);
return NotUsed.getInstance();
});
public Source<String, NotUsed> names() {
// rowSource can be re-used, since it will start a new
// query for each materialization, fully supporting backpressure
// for each materialized stream:
return rowSource.map(row -> row.getField("name"));
}
}
// #example
}

View file

@ -0,0 +1,58 @@
/*
* Copyright (C) 2019-2022 Lightbend Inc. <https://www.lightbend.com>
*/
package jdocs.stream.operators.source;
//#imports
import java.util.concurrent.Flow.Publisher;
import org.apache.pekko.NotUsed;
import org.apache.pekko.stream.javadsl.Source;
import org.apache.pekko.stream.javadsl.JavaFlowSupport;
//#imports
import org.apache.commons.lang.NotImplementedException;
public interface FromPublisher {
// We are 'faking' the JavaFlowSupport API here so we can include the signature as a snippet in the API,
// because we're not publishing those (jdk9+) classes in our API docs yet.
static class JavaFlowSupport {
public static final class Source {
public
// #api
static <T> akka.stream.javadsl.Source<T, NotUsed> fromPublisher(Publisher<T> publisher)
// #api
{
return akka.stream.javadsl.JavaFlowSupport.Source.<T>fromPublisher(publisher);
}
}
}
static class Row {
public String getField(String fieldName) {
throw new NotImplementedException();
}
}
static class DatabaseClient {
Publisher<Row> fetchRows() {
throw new NotImplementedException();
}
}
DatabaseClient databaseClient = null;
// #example
class Example {
public Source<String, NotUsed> names() {
// A new subscriber will subscribe to the supplied publisher for each
// materialization, so depending on whether the database client supports
// this the Source can be materialized more than once.
return JavaFlowSupport.Source.<Row>fromPublisher(databaseClient.fetchRows())
.map(row -> row.getField("name"));
}
}
// #example
}