Index

A B C D E F G H I L M N R S T
All Classes and Interfaces|All Packages

A

addChild(Scene) - Method in class com.calebleavell.textinterface.scenes.GenericScene

Add a child to the list of children

addChild(Scene) - Method in interface com.calebleavell.textinterface.scenes.Scene

Add a new child to the list of children

addScene(Scene, String) - Method in class com.calebleavell.textinterface.scenes.NumberedSceneSelectorScene

Adds a new scene to choose from

B

build() - Method in class com.calebleavell.textinterface.scenes.ContainerScene.Builder

Build the ContainerScene

build() - Method in class com.calebleavell.textinterface.scenes.GenericScene.Builder

Initializes a new object of the class that the implementation is contained in

build() - Method in class com.calebleavell.textinterface.scenes.NumberedListInputScene.Builder

Return a new instance of NumberedListScene with the specified fields

build() - Method in class com.calebleavell.textinterface.scenes.NumberedListScene.Builder

Return the new NumberedListScene instance

build() - Method in class com.calebleavell.textinterface.scenes.NumberedSceneSelectorScene.Builder

build() - Method in class com.calebleavell.textinterface.scenes.TextInputScene.Builder

build() - Method in class com.calebleavell.textinterface.scenes.TextScene.Builder

build() - Method in class com.calebleavell.textinterface.TextApplication.Builder

Builder() - Constructor for class com.calebleavell.textinterface.scenes.ContainerScene.Builder

Builder() - Constructor for class com.calebleavell.textinterface.scenes.GenericScene.Builder

Builder() - Constructor for class com.calebleavell.textinterface.scenes.NumberedListInputScene.Builder

Builder() - Constructor for class com.calebleavell.textinterface.scenes.NumberedListScene.Builder

Builder() - Constructor for class com.calebleavell.textinterface.scenes.NumberedSceneSelectorScene.Builder

Builder() - Constructor for class com.calebleavell.textinterface.scenes.TextInputScene.Builder

Builder() - Constructor for class com.calebleavell.textinterface.scenes.TextScene.Builder

Builder() - Constructor for class com.calebleavell.textinterface.TextApplication.Builder

Constructor It takes no arguments, but it sets the name in the Builder of the super class to "root"

C

children(Scene...) - Method in class com.calebleavell.textinterface.scenes.GenericScene.Builder

Set the children field dynamically

children(List<Scene>) - Method in class com.calebleavell.textinterface.scenes.GenericScene.Builder

Set the children field

com.calebleavell.textinterface - package com.calebleavell.textinterface

com.calebleavell.textinterface.scenes - package com.calebleavell.textinterface.scenes

ContainerScene - Class in com.calebleavell.textinterface.scenes

ContainerScene Class

ContainerScene(ContainerScene.Builder) - Constructor for class com.calebleavell.textinterface.scenes.ContainerScene

Constructor

ContainerScene.Builder - Class in com.calebleavell.textinterface.scenes

This Builder class is simply a concrete version of the GenericScene classes builder

convertStringListToTextSceneList(String...) - Static method in class com.calebleavell.textinterface.scenes.NumberedListScene

Converts an array of strings to a List of TextScenes

D

DemoApp - Class in com.calebleavell.textinterface

This is a simple random number generator.

DemoApp() - Constructor for class com.calebleavell.textinterface.DemoApp

displayText(TextScene) - Method in class com.calebleavell.textinterface.scenes.TextInputScene.Builder

displayText(String) - Method in class com.calebleavell.textinterface.scenes.TextInputScene.Builder

E

endWithNewLine(boolean) - Method in class com.calebleavell.textinterface.scenes.TextScene.Builder

executeFunctions() - Method in class com.calebleavell.textinterface.scenes.GenericScene

Linearlly executes each function

executeFunctions() - Method in interface com.calebleavell.textinterface.scenes.Scene

Executes each function of the scene without displaying To execute a specific function call getFunctions and get an element

F

Function - Interface in com.calebleavell.textinterface.scenes

Function Interface

functions(Function...) - Method in class com.calebleavell.textinterface.scenes.GenericScene.Builder

Set the list of functions dynamically

G

generateID() - Static method in class com.calebleavell.textinterface.IDGenerator

GenericScene - Class in com.calebleavell.textinterface.scenes

GenericScene Class

GenericScene(GenericScene.Builder<?>) - Constructor for class com.calebleavell.textinterface.scenes.GenericScene

Takes a builder and extracts necessary fields out of it

GenericScene.Builder<B> - Class in com.calebleavell.textinterface.scenes

Uses a Builder design pattern Extending this class makes extending this Builder easy, but extending any subclasses of this class will be difficult

getChild(long) - Method in class com.calebleavell.textinterface.scenes.GenericScene

Executes a depth-first seach on the children Returns the first child with name matching param ID Unlike searching by name, there will only ever be up to one matching child

getChild(long) - Method in interface com.calebleavell.textinterface.scenes.Scene

Finds the child scene tha matches ID and returns it The method of search is up to implementation Regardless of development, there will only be one child with the same ID (if any)

getChild(long, Class<T>) - Method in class com.calebleavell.textinterface.scenes.GenericScene

Attempts to find a child scene that matches the ID and type of Scene Executes a depth-first search

getChild(long, Class<T>) - Method in interface com.calebleavell.textinterface.scenes.Scene

Attempts to find a child scene that matches the ID and type of Scene

getChild(String) - Method in class com.calebleavell.textinterface.scenes.GenericScene

Executes a depth-first seach on the children Returns the first child with name matching param name

getChild(String) - Method in interface com.calebleavell.textinterface.scenes.Scene

Finds a child scene that matches name and returns it The method of search is up to implementation Depending on development, there may be more than one child with the same name

getChild(String, Class<T>) - Method in class com.calebleavell.textinterface.scenes.GenericScene

Attempts to find a child scene that matches the name and type of Scene Executes a depth-first search

getChild(String, Class<T>) - Method in interface com.calebleavell.textinterface.scenes.Scene

Attempts to find a child scene that matches the name and type of Scene

getChildren() - Method in class com.calebleavell.textinterface.scenes.GenericScene

Getter for children

getChildren() - Method in interface com.calebleavell.textinterface.scenes.Scene

Getter for children

getFunctions() - Method in class com.calebleavell.textinterface.scenes.GenericScene

Getter for functions

getFunctions() - Method in interface com.calebleavell.textinterface.scenes.Scene

getter for functions These functions are Consumers that can take anything that extends Scene In general, implementation will pass in "this" as the Scene

getHome() - Method in class com.calebleavell.textinterface.TextApplication

Getter for home

getID() - Method in class com.calebleavell.textinterface.scenes.GenericScene

Getter for id

getID() - Method in interface com.calebleavell.textinterface.scenes.Scene

Getter for id

getInput() - Method in interface com.calebleavell.textinterface.scenes.Inputtable

Getter for the input collected from the user

getInput() - Method in class com.calebleavell.textinterface.scenes.NumberedListInputScene

getInput() - Method in class com.calebleavell.textinterface.scenes.TextInputScene

getInputGetter() - Method in class com.calebleavell.textinterface.scenes.NumberedListInputScene

getList() - Method in class com.calebleavell.textinterface.scenes.NumberedListScene

Getter for list

getName() - Method in class com.calebleavell.textinterface.scenes.GenericScene

Getter for name

getName() - Method in interface com.calebleavell.textinterface.scenes.Scene

Getter for name

getNumberedList() - Method in class com.calebleavell.textinterface.scenes.NumberedListInputScene

getStartIndex() - Method in class com.calebleavell.textinterface.scenes.NumberedListScene

Getter for startIndex

getText() - Method in class com.calebleavell.textinterface.scenes.TextScene

Getter for text

H

home(Scene) - Method in class com.calebleavell.textinterface.TextApplication.Builder

I

IDGenerator - Class in com.calebleavell.textinterface

The ID class has a static counter for id's, and can generate a unique id.

IDGenerator() - Constructor for class com.calebleavell.textinterface.IDGenerator

inputGetter(TextInputScene) - Method in class com.calebleavell.textinterface.scenes.NumberedListInputScene.Builder

Inputtable<T> - Interface in com.calebleavell.textinterface.scenes

Inputtable Interface

isTerminated() - Method in class com.calebleavell.textinterface.scenes.GenericScene

Return whether or not the scene is in a termninated state note that the scene comes out of a termniated state when it is run again

isTerminated() - Method in interface com.calebleavell.textinterface.scenes.Scene

returns whether or not a scene is currently terminated

L

list(NumberedListScene) - Method in class com.calebleavell.textinterface.scenes.NumberedListInputScene.Builder

list(String...) - Method in class com.calebleavell.textinterface.scenes.NumberedListInputScene.Builder

list(String...) - Method in class com.calebleavell.textinterface.scenes.NumberedListScene.Builder

Converts an array of Strings into the Scene's List of TextScenes

list(List<TextScene>) - Method in class com.calebleavell.textinterface.scenes.NumberedListScene.Builder

listText(String...) - Method in class com.calebleavell.textinterface.scenes.NumberedSceneSelectorScene.Builder

M

main(String[]) - Static method in class com.calebleavell.textinterface.DemoApp

MAX_ITERATIONS_ON_TOSTRING - Static variable in class com.calebleavell.textinterface.scenes.GenericScene

The number of layers of children to add to the toString()

N

name(String) - Method in class com.calebleavell.textinterface.scenes.GenericScene.Builder

Set the name field

NumberedListInputScene - Class in com.calebleavell.textinterface.scenes

NumberedListInputScene

NumberedListInputScene(NumberedListInputScene.Builder) - Constructor for class com.calebleavell.textinterface.scenes.NumberedListInputScene

Return a new instance based on the builder fields

NumberedListInputScene.Builder - Class in com.calebleavell.textinterface.scenes

The Builder class

NumberedListScene - Class in com.calebleavell.textinterface.scenes

NumberedListScene

NumberedListScene(NumberedListScene.Builder) - Constructor for class com.calebleavell.textinterface.scenes.NumberedListScene

Return a new instance based on the builder fields

NumberedListScene.Builder - Class in com.calebleavell.textinterface.scenes

Builder class

NumberedSceneSelectorScene - Class in com.calebleavell.textinterface.scenes

NumberedSceneSelectorScene Class

NumberedSceneSelectorScene(NumberedSceneSelectorScene.Builder) - Constructor for class com.calebleavell.textinterface.scenes.NumberedSceneSelectorScene

Return a new instance based on the builder fields

NumberedSceneSelectorScene.Builder - Class in com.calebleavell.textinterface.scenes

Builder Class

R

run() - Method in interface com.calebleavell.textinterface.scenes.Function

Excecute the Function

run() - Method in class com.calebleavell.textinterface.scenes.GenericScene

Executes its functions, then displays its children

run() - Method in class com.calebleavell.textinterface.scenes.NumberedListInputScene

Execute the program in the following order: 1.

run() - Method in class com.calebleavell.textinterface.scenes.NumberedListScene

Executes the program as follows: 1.

run() - Method in class com.calebleavell.textinterface.scenes.NumberedSceneSelectorScene

display displays the selector, gets the input, then display the chosen scene NOTE: all child scenes and functions will be ran BEFORE the selected scene is displayed

run() - Method in class com.calebleavell.textinterface.scenes.TextInputScene

Executes the scene by displaying the prompt, collecting the input, then running children and functions

run() - Method in class com.calebleavell.textinterface.scenes.TextScene

Displays the input if that's set, or more commonly, displays its set text.

runChildren() - Method in class com.calebleavell.textinterface.scenes.GenericScene

Linearly displays Children

runChildren() - Method in interface com.calebleavell.textinterface.scenes.Scene

Run child scenes in a way designed for the implementation This could just be a linear display, a unique selection of children to display, or anything else

S

Scene - Interface in com.calebleavell.textinterface.scenes

Scene Interface

sceneList(Scene...) - Method in class com.calebleavell.textinterface.scenes.NumberedSceneSelectorScene.Builder

sceneList(List<Scene>) - Method in class com.calebleavell.textinterface.scenes.NumberedSceneSelectorScene.Builder

self() - Method in class com.calebleavell.textinterface.scenes.GenericScene.Builder

Return a version of this of type B It is safe to suppress the warning on the user side, assuming subclasses are implemented correctly

setChildren(List<Scene>) - Method in class com.calebleavell.textinterface.scenes.GenericScene

Setter for children

setChildren(List<Scene>) - Method in interface com.calebleavell.textinterface.scenes.Scene

Setter for children

setEndWithNewLine(boolean) - Method in class com.calebleavell.textinterface.scenes.TextScene

Setter for endWithNewLine

setHome(Scene) - Method in class com.calebleavell.textinterface.TextApplication

Setter for home

setInputGetter(TextInputScene) - Method in class com.calebleavell.textinterface.scenes.NumberedListInputScene

Set the input collector

setList(NumberedListScene) - Method in class com.calebleavell.textinterface.scenes.NumberedListInputScene

Set the NumberedList

setList(List<TextScene>) - Method in class com.calebleavell.textinterface.scenes.NumberedListScene

Setter for list

setName(String) - Method in class com.calebleavell.textinterface.scenes.GenericScene

Setter for name

setName(String) - Method in interface com.calebleavell.textinterface.scenes.Scene

Setter for name

setStartIndex(int) - Method in class com.calebleavell.textinterface.scenes.NumberedListScene

Setter for startIndex

setText(String) - Method in class com.calebleavell.textinterface.scenes.TextScene

Setter for text

startIndex(int) - Method in class com.calebleavell.textinterface.scenes.NumberedListScene.Builder

T

terminate() - Method in class com.calebleavell.textinterface.scenes.GenericScene

Terminates scene execution

terminate() - Method in interface com.calebleavell.textinterface.scenes.Scene

Quits a scene early

text(Inputtable<?>) - Method in class com.calebleavell.textinterface.scenes.TextScene.Builder

Allows easy translation from input to output Displays the direct input from another scene

text(String) - Method in class com.calebleavell.textinterface.scenes.TextScene.Builder

TextApplication - Class in com.calebleavell.textinterface

TextApplication Class

TextApplication(TextApplication.Builder) - Constructor for class com.calebleavell.textinterface.TextApplication

Return a new TextApplication based on builder fields

TextApplication.Builder - Class in com.calebleavell.textinterface

Builder class

TextInputScene - Class in com.calebleavell.textinterface.scenes

TextScene Class

TextInputScene(TextInputScene.Builder) - Constructor for class com.calebleavell.textinterface.scenes.TextInputScene

Returns

TextInputScene.Builder - Class in com.calebleavell.textinterface.scenes

TextScene - Class in com.calebleavell.textinterface.scenes

Displays a piece of text

TextScene(TextScene.Builder) - Constructor for class com.calebleavell.textinterface.scenes.TextScene

Return new TextScene based on builder fields

TextScene.Builder - Class in com.calebleavell.textinterface.scenes

Builder class

toString() - Method in class com.calebleavell.textinterface.scenes.GenericScene

Recursively generates toString with info for this scene and all children Will only go as deep as MAX_ITERATIONS_ON_TOSTRING

toString(int, boolean) - Method in class com.calebleavell.textinterface.scenes.GenericScene

recursive helper method for toString()

toString(int, boolean) - Method in class com.calebleavell.textinterface.scenes.NumberedSceneSelectorScene

Overrides GenericScene's toString to include it's scene options

toString(int, boolean) - Method in interface com.calebleavell.textinterface.scenes.Scene

Allows for recursive tabbing of children for toString In general, the overrided toString() method should return toString(0)

A B C D E F G H I L M N R S T
All Classes and Interfaces|All Packages