Package org.nwolfhub.easycli

Class EasyCLI

java.lang.Object

org.nwolfhub.easycli.EasyCLI

public class EasyCLI
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
String	activeTemplate
String	commandNotFoundText
Level	level
Boolean	printNotFoundText

Constructor Summary

Constructors

Constructor	Description
EasyCLI()	Creates an EasyCLI instance.
EasyCLI(boolean overrideStreams)	Creates an EasyCLI instance.
EasyCLI(InputStream in, PrintStream out)	Creates an EasyCLI instance

Method Summary

Modifier and Type	Method	Description
void	addTask(String command, InputTask task)
void	addTemplate(String name, Template template)
void	addTemplate(Template template)
void	addTemplate(Template template, String name)
void	addVariable(Variable v)	Adds a new variable to the list of variables processed by the variable processor.
void	clearVariables()	Clears all the variables in the list of variables processed by the variable processor.
void	detectLogLevel()
void	detectLogLevel(File file)
String	getActiveTemplate()
Level	getLevel()
List<InputTask>	getTasks()
List<Template>	getTemplates()
List<Variable>	getVariables()	Returns a list of all variables processed by the variable processor.
void	print(Class<?> template, String text)
void	print(Object... objects)
void	print(String text)
void	print(String text, Class<?> template)
void	print(String template, Object... objects)
void	print(String text, String template)
void	print(String text, Template template)
void	print(Template template, Object... objects)
void	printAtLevel(Class<?> template, Level level, String text)
void	printAtLevel(String text, String template, Level level)
void	printAtLevel(String text, Level level)
void	printAtLevel(String text, Level level, Class<?> template)
void	printAtLevel(String template, Level level, Object... objects)
void	printAtLevel(String text, Template template, Level level)
void	printAtLevel(Level level, Object... objects)
void	printAtLevel(Template template, Level level, Object... objects)
void	removeTask(String command)
void	removeTemplate(String name)
void	removeVariable(int index)	Removes the variable at the specified index from the list of variables processed by the variable processor.
EasyCLI	setActiveTemplate(String activeTemplate)
EasyCLI	setLevel(Level level)
void	startListening()
void	stopListening()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

activeTemplate

public String activeTemplate

level

public Level level

commandNotFoundText

public String commandNotFoundText

printNotFoundText

public Boolean printNotFoundText

Constructor Details

EasyCLI

public EasyCLI(InputStream in,
 PrintStream out)

Creates an EasyCLI instance

Parameters:

in - - input stream to read info

out - - output stream

EasyCLI

public EasyCLI()

Creates an EasyCLI instance. Uses System streams

EasyCLI

public EasyCLI(boolean overrideStreams)

Creates an EasyCLI instance. Uses System streams

Parameters:

overrideStreams - - will override system streams and disallow printing in them. ErrorStream won't be overridden

Method Details

stopListening

public void stopListening()

startListening

public void startListening()

addTemplate

public void addTemplate(Template template)

addTemplate

public void addTemplate(Template template,
 String name)

addTemplate

public void addTemplate(String name,
 Template template)

removeTemplate

public void removeTemplate(String name)

getTemplates

public List<Template> getTemplates()

addTask

public void addTask(String command,
 InputTask task)

removeTask

public void removeTask(String command)

getTasks

public List<InputTask> getTasks()

getActiveTemplate

public String getActiveTemplate()

setActiveTemplate

public EasyCLI setActiveTemplate(String activeTemplate)

getLevel

public Level getLevel()

setLevel

public EasyCLI setLevel(Level level)

detectLogLevel

public void detectLogLevel()
                    throws IOException

Throws:

IOException

detectLogLevel

public void detectLogLevel(File file)
                    throws IOException

Throws:

IOException

print

public void print(String text,
 String template)

print

public void print(String text,
 Template template)

print

public void print(String text)

print

public void print(Object... objects)

print

public void print(Template template,
 Object... objects)

print

public void print(String template,
 Object... objects)

print

public void print(Class<?> template,
 String text)

print

public void print(String text,
 Class<?> template)

printAtLevel

public void printAtLevel(String text,
 String template,
 Level level)

printAtLevel

public void printAtLevel(String text,
 Template template,
 Level level)

printAtLevel

public void printAtLevel(String text,
 Level level)

printAtLevel

public void printAtLevel(Level level,
 Object... objects)

printAtLevel

public void printAtLevel(Template template,
 Level level,
 Object... objects)

printAtLevel

public void printAtLevel(String template,
 Level level,
 Object... objects)

printAtLevel

public void printAtLevel(Class<?> template,
 Level level,
 String text)

printAtLevel

public void printAtLevel(String text,
 Level level,
 Class<?> template)

addVariable

public void addVariable(Variable v)

Adds a new variable to the list of variables processed by the variable processor.

Parameters:

v - the variable to be added

removeVariable

public void removeVariable(int index)

Removes the variable at the specified index from the list of variables processed by the variable processor.

Parameters:

index - the index of the variable to be removed

clearVariables

public void clearVariables()

Clears all the variables in the list of variables processed by the variable processor.

getVariables

public List<Variable> getVariables()

Returns a list of all variables processed by the variable processor.

Returns:

a list of Variable objects