Home

This is a mirror of the cyclops-react wiki user guide may not always be up-to-date.

• Getting Started
• Project Goals
• Some common features
• Collections
  • Collection eXtentions
  • Scala
  • Clojure
  • Dexx
  • JavaSlang
• Functions
  • An Introduction
    • to FluentFunctions
    • to Mutable, LazyImmutable & ExceptionSoftener
    • to Memoization
    • to Currying, Uncurrying & Partial Application
    • to Type Inferencing
  • Read on more articles on functions..
• Control Structures
  • Combiners (Monoids & Semigroups)
  • Asynchronous execution
    • Futures
    • SimpleReact : Bulk ops on Futures
  • Lazy Evaluation
    • Eval
    • Trampoline : Recursion
  • Sum & Product types (Optionals & Tuples)
    • Maybe
    • Try
    • FeatureToggle
    • Xor
    • Tuples : Product Types
    • Ior : both
  • Monads
    • AnyM - a functor for Monads
    • Monad transformers via AnyM
    • For : for comprehensions api
    • Reader : Functional Dependency Injection
  • Structural Pattern matching
    • Visitor pattern
    • An introduction
      • to the matching dsl
      • to compositional predicates
      • to recursive matching
      • to structural matching on JDK classes
    • Read more articles on pattern matching..
• Reactive Streams
  • Reactive Streams Publishers
  • Reactive Streams Subscribers
• Streaming
  • An Introduction
    • to StreamUtils, Streamable & ReactiveSeq
    • to HotStreams and Reactive Streams
    • to sliding and grouping
    • to value extraction
    • to error handling
    • to scheduling
    • to time based ops / onePer / debounce
    • to zipping
    • to efficient reversal
    • to take / drop / cycle
    • to flatMap / map and for comprehensions
    • to empty stream and single value handling
    • to filtering and scanning
    • to assertions, folds & conversions
    • to async ops
  • Performance
  • Pushing data into Streams
    • StreamSource
    • Pipes
  • Repeatable Streams (Streamable)
  • Plumbing Streams
    • Backpressure
  • SQL Window functions (and more) inherited from jooλ
  • ReactiveSeq (powerful sequential Streaming)
    • ReactiveSeq examples
  • FutureStreams
    • Operators
      • The tutorial (with videos)
      • Examples
    • FutureStream concepts
      • Performance
      • Acting on Futures or Acting on Results
      • Configuration
• Type Interfaces in cyclops-react
• Low level For Comprehensions
• Higher Kinded Types
• Type classes
• Integrations
• Functional & Reactive Microservices

Getting Started

• Adding cyclops-react dependency
• Adding the legacy cyclops-modules

Project Goals

• Project Goals
• Interoperability

Some common features

• custom conversions and operators Available on all types.
• Predicates for filtering

Collections

Collections eXtensions

• Working with persistent and mutable collections
• Lazy Extended Collections - Fast and powerful
• Extending JDK 8 Collections

Scala

• Scala Persistent Collection Bindings

Clojure

• Clojure Persistent Collection Bindings

Dexx

• Dexx Persistent Collection Bindings

JavaSlang

• JavaSlang Persistent Collection Bindings

Functions

• Working with Lambdas
• Fluent Functions in cyclops - blog post
• Convertable mixin
• Mutable boxes
• LazyImmutable set once box
• Memoization
• Partial Application
• Exception Softener
• Utilities for working with Functions
• Memoization, Currying, Uncurrying and Type inferencing
• 4 flavours of Java 8 Functons Blog post

Control Structures

Pattern matching and the visitor pattern

• Built-in Visitor pattern
• Structural Pattern matching
• Matchables pre-canned matching
• Predicates for guards
• Straightforward Structural Pattern Matching - blog post

Combiners

• Monoids & Semigroups

Asynchronous execution

Futures

• FutureW - a better CompletableFuture API
• CompletableFutures for working with CompletableFutues

SimpleReact : Future Bulk Ops

• SimpleReact : Stream of Futures
• Let the illusion die : roll your own
• SimpleReact : DataFlow

See FutureStreams below for more advanced - infinite lazy Streams of Futures with a huge range of extended operators

Lazy Evaluation

Eval

• Eval - monadic, tail recursive, lazy evaluation with caching
• Brief introduction to Eval

Recursion

• Trampoline
• Trampolining: a practical guide for awesome Java Developers

Sum Types

• Working with Optionals

Maybe

• Maybe: just (like Haskell) / none
• Maybe: Future Java Today

Try

• Try functional exception handling for Java 8
• Why cyclops-react Try
• Try examples
• When Functional Try outperforms Try / Catch

Feature Toggle

• Feature Toggling
• Feature Toggling with cyclops Blog post

Xor

• Validator : lazy active validator, works with Xor
• Xor : exclusive Or, a right biased Either type

Product types (Tuples)

• Tuples from jOOλ: Javadoc link. cyclops-react extends jooλ
• Power Tuples independent cyclops module

Product & Sum types

• Ior

Monads

A Functor for monads (AnyM)

AnyM is a functor for Monads, with two monadic sub-types. AnyMValue a monad for monadic values. AnyMSeq a monad for non-scalar monads.

• AnyM intro
• AnyM creational methods
• AnyM for comprehensions
• Introduction to the cyclops-monad API
• cyclops-react organizes the cambrian expolsion of Java 8 libraries

Monad transformers via AnyM

AnyM Refresher

• ListT example
• OptionalT example
• MaybeT example
• FutureWT example
• CompletableFutureT

For comprehension API

• For intro

Related : For Comprehensions in Scala

• Sequence comprehensions in Scala
• How does Yield work?

Compose your own

• Low level For Comprehensions

Reader monad

• Reader functional dependency injection

Reactive Streams

See also

• ReactiveTask
• HotStream
• PausableHotStream

Reactive Streams Publishers

All cyclops-react data types implement Reactive Streams Publisher (e.g. extended collections, AnyM, Xor, Ior, Try, Maybe, FutureW, ReactiveSeq, LazyFutureStream and more).

• Example : Reactive Streams Publisher & Subscriber

Reactive Streams Subscribers

• SeqSubscriber - subscribe to sequences / streams
• ValueSubscriber - subscribe for a single value
• QueueBasedSubscriber

Streaming

• Introduction to cyclops-react Streams
• Streaming overview : ReactiveSeq, Streamable and more
• A rational : Java 8 Streams 10 missing features

Performance

• Optimizing cyclops-react Streams
• Fast Futures and Fast Future Pooling : Fast Futures ~2.5 faster than CompletableFutures in LazyFutureStreams

Pushing data into Streams

• Stackoverflow answer showing how to do it with Queues

StreamSource

• StreamSource for pushable Streams
• Pushing data into Java 8 Streams - blog entry

Pipes

• Pipes event bus

Repeatable Streams (Streamable)

• Streamable
• Streamable as a mixin

Plumbing Streams

• Queues explained
• Signals explained
• Topics explained
• Plumbing Streams with Queues, Topics and Signals
• Agrona wait free Queues
• Wait strategies for working with Wait Free Queues

Backpressure

• Applying Backpressure across Streams

SQL Style Streaming : Features inherited from jooλ

ReactiveSeq & LazyFutureStream extend jooλ's Seq. Extended Collections implement jooλ Collection API.

• Rationale for Seq
• Combining collectors
• Windowing functions in Java
• Windowing functions example
• Group by and SQL Aggregrations in Java 8
• Generating an Alphbetical sequence
• Common SQL clauses Stream equivalents
• jooq blog on jooλ

ReactiveSeq (powerful sequential Streaming)

• Scheduling Streams
• Scheduling Streams example blog post
• Asynchronous execution
• For comprehensions
• ReactiveSeq examples

FutureStreams

• LazyFutureStream overview : A powerful API for infinite parallel Streaming
• SimpleReactStream overview : an easy to use API for finite eager parellel Streaming
• Stream type overview
• LazyFutureStream & reactive-streams
• A simple API (simple-react) and a rich api (LazyFutureStream
• Asynchronous terminal operations

Operators

• Batching, time control, sharding, zipping
• onFail
• Event based : forEachWithError etc
• For comprehensions
• Retry
• Take, Skip and Sample
• Scheduling

The tutorial (with videos)

• getting started
• error handling
• filter /map/ reduce /flatMap
• choosing a stream type
• stream creation
• pooling reactors
• pull / push model
• flow control
• batching and chunking
• sharding
• zipping streams
• firstOf, anyOf, allOf
• stream operations
• sequence operations

Examples

• Getting started example
• Building a non-blocking NIO Rest Client
• Bulk loading files
• Converting examples from RxJava
• Implementing a data cache
• Implementing a Quorum
• Reacting to asynchronous events with a Stream of CompletableFutures
• Selecting the fastest algorithm
• Asynchronous fun with Vert.x
• JDBC Processing

FutureStream concepts

• Understanding LazyFutureStreams behavior
• Quick overview of SimpleReactStream
• Understanding the push-pull model of FutureStreams
• Let the illusion die Build your own FutureStreams
• FutureStream comparison matrix : note EagerFutureStream is discontinued

Performance

• Automatic optimization
• Async vs sync future execution
• Automemoize

Acting on Futures or Acting on Results

• Operating on futures
• Acting on Futures

Configuration

• React pools - elastic thread pools
• Fine Tuning SimpleReact
• Sharing a forkJoinPool with Parallel Streams - info purposes, don't do this!
• Separating task executors

Type Interfaces in cyclops-react

cyclops-react Types are defined in the types package and sub-packages

• ApplicativeFunctor
• BiFunctor
• Combiner
• EmptyUnit
• Filterable
• Foldable
• Functor
• HotStream
• MonadicValue
• MonadicValue1
• MonadicValue2
• PausableHotStream
• ReactiveTask
• To
• Traversable
• Value
• Visitable
• Unit
• Zippable

For Comprehension Mechanics

Using the cyclops-react Do builder. In general prefer using com.aol.cyclops.control.For to the lower level Do. Do is useful for building your own For Comprehension interpreter (see For intro.

• Extensible for comprehensions : used to build type specific For Comprehensions elsewhere
• For Comprehensions explained
• The neophytes guide to Java 8 : Welcome to the Future - the syntax is better today
• Dependency injection with the Reader monad - cyclops now has it's own Reader monad.

Higher Kinded Types

• Higher Kinded Types in cyclops

Type classes

[monad,applicative, functor, unit, monadPlus based on HKT]

• Type classes

• Applicative Type Class

Integrations

Integrations include

1. AnyM support
2. For comprehension support
3. Higher Kinded Type encodings for 3rd party libraries
4. Lazy / faster collections by taking advantage of strengths of each library

• Javaslang
• Guava
• Functional Java
• RxJava
• Reactor

Functional & Reactive Microservices

• Microserver : micro-reactive