Home

Cyclops X wiki

This is a work in progress. For cyclops-react v1 wiki see here

Getting started

Add cyclops X as a dependency to your project

compile 'com.oath.cyclops:cyclops:x.y.z'

Overview

• Persistent Collections
  • LazySeq : an immutable, shared memory, totally lazy LinkedList
  • Seq : an immutable, shared memory, eager LinkedList
  • Vector : an immutable, shared memory, super fast ArrayList
  • NonEmptyList : an immutable, shared memory, eager LinkedList guaranteed to have at least one value
• Control Structures
  • Eval : lazy, stack-safe evaluation
  • Option : a safe, eager Optional type
  • Maybe : a safe, lazy, reactive & stack-safe Optional type
  • Either : a safe, eager sum / union type
  • LazyEither : a safe, lazy, reactive & stack-safe sum / union type
  • Try : a safe, lazy or eager or reactive, type safe sum / union type for error handling
  • Validated : a safe accumulating sum / union type
  • Trampoline : stack-safe recursion and same thread concurrency
  • Future : a safe and sensible api for CompletableFuture
• Core Reactive Programming
  • Managed : functional resource management - try / catch / finally
• Companion Classes
• Functions and lamdas
• Pattern matching
• Tuples and boxes
• Reactive Collections
• FutureStreams
• AnyM
• Pure functional programming

Core Patterns

• For comprehensions
• Extracting values from Cyclops types (e.g. Option, ImmutableList)
• Folding
• Sequence and Traverse
• Lazy and Strict (eager) operations
• Synchronous and asynchronous operations
• Simulation of higher kinded types
• Sealed type hierarchies
• Semigroups, Monoids, Reducers