java.lang.Object

org.daisy.cli.AbstractUI

org.daisy.braille.ui.BasicUI

public class BasicUI extends AbstractUI

Provides a basic command line UI for core functionality in org.daisy.braille.

Author:: Joel Håkansson

Nested Class Summary

Nested classes/interfaces inherited from class org.daisy.cli.AbstractUI
AbstractUI.Argument, AbstractUI.Definition, AbstractUI.ExitCode, AbstractUI.OptionalArgument
Field Summary

Fields

Modifier and Type

Field

Description

static final String

emboss

static final String

generate

static final String

list

static final String

merge

static final String

pef2text

static final String

split

static final String

text2pef

static final String

validate

Fields inherited from class org.daisy.cli.AbstractUI
ARG_PREFIX
Constructor Summary

Constructors

Constructor

Description

BasicUI(String[] args)

Creates a new Basic UI
Method Summary

Modifier and Type

Method

Description

String

getName()

Gets the name for the UI

List<AbstractUI.OptionalArgument>

getOptionalArguments()

Gets optional arguments

List<AbstractUI.Argument>

getRequiredArguments()

Gets required arguments

static void

main(String[] args)

Command line entry point

void

run()

Runs the application.

void

setPluginsDir(File dir)

Sets the context class loader to an URLClassLoader containing the jars found in the specified path.

Methods inherited from class org.daisy.cli.AbstractUI
displayHelp, exitWithCode, exitWithCode, expandShortForm, getDefinitionList, getOptional, getRequired, setKeyValueDelimiter, setOptionalArgumentPrefix, toMap

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- emboss
  
  public static final String emboss
  See Also:
  
  Constant Field Values
- text2pef
  
  public static final String text2pef
  See Also:
  
  Constant Field Values
- pef2text
  
  public static final String pef2text
  See Also:
  
  Constant Field Values
- validate
  
  public static final String validate
  See Also:
  
  Constant Field Values
- split
  
  public static final String split
  See Also:
  
  Constant Field Values
- merge
  
  public static final String merge
  See Also:
  
  Constant Field Values
- generate
  
  public static final String generate
  See Also:
  
  Constant Field Values
- list
  
  public static final String list
  See Also:
  
  Constant Field Values
Constructor Details
- BasicUI
  
  public BasicUI(String[] args)
  
  Creates a new Basic UI
  
  Parameters:
  
  args - the application arguments
Method Details
- setPluginsDir
  
  public void setPluginsDir(File dir)
  
  Sets the context class loader to an URLClassLoader containing the jars found in the specified path.
  
  Parameters:
  
  dir - the directory to search for jar-files.
- run
  
  public void run() throws Exception
  
  Runs the application.
  
  Throws:
  
  Exception - if something bad happens
- main
  
  public static void main(String[] args) throws Exception
  
  Command line entry point
  
  Parameters:
  
  args - the application arguments
  
  Throws:
  
  Exception
- getName
  
  public String getName()
  
  Description copied from class: AbstractUI
  
  Gets the name for the UI
  
  Specified by:
  
  getName in class AbstractUI
  
  Returns:
  
  returns the UI name
- getRequiredArguments
  
  public List<AbstractUI.Argument> getRequiredArguments()
  
  Description copied from class: AbstractUI
  
  Gets required arguments
  
  Specified by:
  
  getRequiredArguments in class AbstractUI
  
  Returns:
  
  returns a list of required arguments that can be passed to the UI on startup
- getOptionalArguments
  
  public List<AbstractUI.OptionalArgument> getOptionalArguments()
  
  Description copied from class: AbstractUI
  
  Gets optional arguments
  
  Specified by:
  
  getOptionalArguments in class AbstractUI
  
  Returns:
  
  returns a list of optional arguments that can be passed to the UI on startup

Class BasicUI

Nested Class Summary

Nested classes/interfaces inherited from class org.daisy.cli.AbstractUI

Field Summary

Fields inherited from class org.daisy.cli.AbstractUI

Constructor Summary

Method Summary

Methods inherited from class org.daisy.cli.AbstractUI

Methods inherited from class java.lang.Object

Field Details

emboss

text2pef

pef2text

validate

split

merge

generate

list

Constructor Details

BasicUI

Method Details

setPluginsDir

run

main

getName

getRequiredArguments

getOptionalArguments