org.opencypher.railroad

Class Diagram

java.lang.Object

org.opencypher.railroad.Diagram

public final class Diagram
extends Object

Logical representation of a rail road diagram.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Diagram.BuilderOptions
static interface	Diagram.CanvasProvider<Canvas,EX extends Exception>
static class	Diagram.Figure
static interface	Diagram.Renderer<Canvas,Text,EX extends Exception>

Method Summary

Modifier and Type	Method and Description
static Diagram.Figure	anyCase(String text)
static Diagram.Figure	branch(Diagram.Figure... branches)
static List<Diagram>	build(Grammar grammar, Diagram.BuilderOptions options)
static Diagram	build(Production production, Diagram.BuilderOptions options)
static Diagram.Figure	charset(String set)
<Result,Canvas,EX extends Exception> Result	convert(Diagram.Renderer<? super Canvas,?,EX> renderer, Diagram.CanvasProvider<? extends Canvas,? extends EX> provider, Function<Canvas,Result> finish)
<Result,Canvas,EX extends Exception,P extends Diagram.CanvasProvider<? extends Canvas,? extends EX> & Function<Canvas,Result>> Result	convert(Diagram.Renderer<? super Canvas,?,EX> renderer, P provider)
<Result,Canvas,EX extends Exception,R extends Diagram.Renderer<? super Canvas,?,EX> & Diagram.CanvasProvider<? extends Canvas,? extends EX> & Function<Canvas,Result>> Result	convert(R renderer)
<Result,Canvas,EX extends Exception,R extends Diagram.Renderer<? super Canvas,?,EX> & Diagram.CanvasProvider<? extends Canvas,? extends EX>> Result	convert(R renderer, Function<Canvas,Result> finish)
static Diagram	diagram(String name, Diagram.Figure figure)
boolean	equals(Object o)
int	hashCode()
static Diagram.Figure	line(Diagram.Figure... content)
static Diagram.Figure	loop(Diagram.Figure forward, Diagram.Figure backwards, int minTimes, Integer maxTimes)
String	name()
static Diagram.Figure	nothing()
static Diagram.Figure	reference(String name)
<Canvas,EX extends Exception> void	render(Diagram.Renderer<Canvas,?,EX> renderer, Diagram.CanvasProvider<? extends Canvas,? extends EX> provider)
<Canvas,EX extends Exception,R extends Diagram.Renderer<Canvas,?,EX> & Diagram.CanvasProvider<? extends Canvas,? extends EX>> void	render(R renderer)
static Diagram.Figure	text(String text)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

build

public static List<Diagram> build(Grammar grammar,
                                  Diagram.BuilderOptions options)

build

public static Diagram build(Production production,
                            Diagram.BuilderOptions options)

render

public <Canvas,EX extends Exception,R extends Diagram.Renderer<Canvas,?,EX> & Diagram.CanvasProvider<? extends Canvas,? extends EX>> void render(R renderer)
                                                                                                                                          throws EX extends Exception

Throws:

EX extends Exception

render

public <Canvas,EX extends Exception> void render(Diagram.Renderer<Canvas,?,EX> renderer,
                                                 Diagram.CanvasProvider<? extends Canvas,? extends EX> provider)
                                          throws EX extends Exception

Throws:

EX extends Exception

convert

public <Result,Canvas,EX extends Exception,R extends Diagram.Renderer<? super Canvas,?,EX> & Diagram.CanvasProvider<? extends Canvas,? extends EX> & Function<Canvas,Result>> Result convert(R renderer)
                                                                                                                                                                                      throws EX extends Exception

Throws:

EX extends Exception

convert

public <Result,Canvas,EX extends Exception,P extends Diagram.CanvasProvider<? extends Canvas,? extends EX> & Function<Canvas,Result>> Result convert(Diagram.Renderer<? super Canvas,?,EX> renderer,
                                                                                                                                                     P provider)
                                                                                                                                              throws EX extends Exception

Throws:

EX extends Exception

convert

public <Result,Canvas,EX extends Exception,R extends Diagram.Renderer<? super Canvas,?,EX> & Diagram.CanvasProvider<? extends Canvas,? extends EX>> Result convert(R renderer,
                                                                                                                                                                   Function<Canvas,Result> finish)
                                                                                                                                                            throws EX extends Exception

Throws:

EX extends Exception

convert

public <Result,Canvas,EX extends Exception> Result convert(Diagram.Renderer<? super Canvas,?,EX> renderer,
                                                           Diagram.CanvasProvider<? extends Canvas,? extends EX> provider,
                                                           Function<Canvas,Result> finish)
                                                    throws EX extends Exception

Throws:

EX extends Exception

name

public String name()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

diagram

public static Diagram diagram(String name,
                              Diagram.Figure figure)

nothing

public static Diagram.Figure nothing()

text

public static Diagram.Figure text(String text)

anyCase

public static Diagram.Figure anyCase(String text)

reference

public static Diagram.Figure reference(String name)

charset

public static Diagram.Figure charset(String set)

line

public static Diagram.Figure line(Diagram.Figure... content)

branch

public static Diagram.Figure branch(Diagram.Figure... branches)

loop

public static Diagram.Figure loop(Diagram.Figure forward,
                                  Diagram.Figure backwards,
                                  int minTimes,
                                  Integer maxTimes)