From c2f3b39090094481960f8fe62061ddcd90425331 Mon Sep 17 00:00:00 2001 From: pkelaita Date: Mon, 18 Sep 2017 01:03:52 -0700 Subject: [PATCH] Updated genrated javdoc for 1.3.0 --- documentation/1.3/ExampleApp.html | 270 ++++++++ documentation/1.3/allclasses-frame.html | 27 + documentation/1.3/allclasses-noframe.html | 27 + documentation/1.3/class-use/ExampleApp.html | 124 ++++ .../1.3/com/jModule/def/BoundedCommand.html | 311 ++++++++++ .../1.3/com/jModule/def/Command.html | 445 ++++++++++++++ .../1.3/com/jModule/def/CommandLogic.html | 389 ++++++++++++ .../com/jModule/def/IndefiniteCommand.html | 266 ++++++++ documentation/1.3/com/jModule/def/Option.html | 331 ++++++++++ .../jModule/def/class-use/BoundedCommand.html | 124 ++++ .../com/jModule/def/class-use/Command.html | 210 +++++++ .../jModule/def/class-use/CommandLogic.html | 204 +++++++ .../def/class-use/IndefiniteCommand.html | 166 +++++ .../1.3/com/jModule/def/class-use/Option.html | 194 ++++++ .../1.3/com/jModule/def/package-frame.html | 24 + .../1.3/com/jModule/def/package-summary.html | 169 ++++++ .../1.3/com/jModule/def/package-tree.html | 147 +++++ .../1.3/com/jModule/def/package-use.html | 196 ++++++ .../1.3/com/jModule/exec/ConsoleClient.html | 540 ++++++++++++++++ .../1.3/com/jModule/exec/Module.html | 383 ++++++++++++ .../jModule/exec/class-use/ConsoleClient.html | 124 ++++ .../com/jModule/exec/class-use/Module.html | 186 ++++++ .../1.3/com/jModule/exec/package-frame.html | 21 + .../1.3/com/jModule/exec/package-summary.html | 151 +++++ .../1.3/com/jModule/exec/package-tree.html | 138 +++++ .../1.3/com/jModule/exec/package-use.html | 160 +++++ .../1.3/com/jModule/util/ConsoleUtil.html | 282 +++++++++ .../1.3/com/jModule/util/InputUtil.html | 329 ++++++++++ .../jModule/util/class-use/ConsoleUtil.html | 124 ++++ .../com/jModule/util/class-use/InputUtil.html | 124 ++++ .../1.3/com/jModule/util/package-frame.html | 21 + .../1.3/com/jModule/util/package-summary.html | 154 +++++ .../1.3/com/jModule/util/package-tree.html | 138 +++++ .../1.3/com/jModule/util/package-use.html | 124 ++++ documentation/1.3/constant-values.html | 124 ++++ documentation/1.3/deprecated-list.html | 124 ++++ documentation/1.3/help-doc.html | 229 +++++++ documentation/1.3/index-files/index-1.html | 162 +++++ documentation/1.3/index-files/index-10.html | 148 +++++ documentation/1.3/index-files/index-11.html | 155 +++++ documentation/1.3/index-files/index-2.html | 139 +++++ documentation/1.3/index-files/index-3.html | 167 +++++ documentation/1.3/index-files/index-4.html | 149 +++++ documentation/1.3/index-files/index-5.html | 160 +++++ documentation/1.3/index-files/index-6.html | 137 +++++ documentation/1.3/index-files/index-7.html | 136 +++++ documentation/1.3/index-files/index-8.html | 137 +++++ documentation/1.3/index-files/index-9.html | 131 ++++ documentation/1.3/index.html | 75 +++ documentation/1.3/overview-frame.html | 23 + documentation/1.3/overview-summary.html | 143 +++++ documentation/1.3/overview-tree.html | 153 +++++ documentation/1.3/package-frame.html | 20 + documentation/1.3/package-list | 3 + documentation/1.3/package-summary.html | 131 ++++ documentation/1.3/package-tree.html | 137 +++++ documentation/1.3/package-use.html | 124 ++++ documentation/1.3/script.js | 30 + documentation/1.3/stylesheet.css | 574 ++++++++++++++++++ .../java/com/jModule/def/CommandLogic.java | 4 +- 60 files changed, 10136 insertions(+), 2 deletions(-) create mode 100644 documentation/1.3/ExampleApp.html create mode 100644 documentation/1.3/allclasses-frame.html create mode 100644 documentation/1.3/allclasses-noframe.html create mode 100644 documentation/1.3/class-use/ExampleApp.html create mode 100644 documentation/1.3/com/jModule/def/BoundedCommand.html create mode 100644 documentation/1.3/com/jModule/def/Command.html create mode 100644 documentation/1.3/com/jModule/def/CommandLogic.html create mode 100644 documentation/1.3/com/jModule/def/IndefiniteCommand.html create mode 100644 documentation/1.3/com/jModule/def/Option.html create mode 100644 documentation/1.3/com/jModule/def/class-use/BoundedCommand.html create mode 100644 documentation/1.3/com/jModule/def/class-use/Command.html create mode 100644 documentation/1.3/com/jModule/def/class-use/CommandLogic.html create mode 100644 documentation/1.3/com/jModule/def/class-use/IndefiniteCommand.html create mode 100644 documentation/1.3/com/jModule/def/class-use/Option.html create mode 100644 documentation/1.3/com/jModule/def/package-frame.html create mode 100644 documentation/1.3/com/jModule/def/package-summary.html create mode 100644 documentation/1.3/com/jModule/def/package-tree.html create mode 100644 documentation/1.3/com/jModule/def/package-use.html create mode 100644 documentation/1.3/com/jModule/exec/ConsoleClient.html create mode 100644 documentation/1.3/com/jModule/exec/Module.html create mode 100644 documentation/1.3/com/jModule/exec/class-use/ConsoleClient.html create mode 100644 documentation/1.3/com/jModule/exec/class-use/Module.html create mode 100644 documentation/1.3/com/jModule/exec/package-frame.html create mode 100644 documentation/1.3/com/jModule/exec/package-summary.html create mode 100644 documentation/1.3/com/jModule/exec/package-tree.html create mode 100644 documentation/1.3/com/jModule/exec/package-use.html create mode 100644 documentation/1.3/com/jModule/util/ConsoleUtil.html create mode 100644 documentation/1.3/com/jModule/util/InputUtil.html create mode 100644 documentation/1.3/com/jModule/util/class-use/ConsoleUtil.html create mode 100644 documentation/1.3/com/jModule/util/class-use/InputUtil.html create mode 100644 documentation/1.3/com/jModule/util/package-frame.html create mode 100644 documentation/1.3/com/jModule/util/package-summary.html create mode 100644 documentation/1.3/com/jModule/util/package-tree.html create mode 100644 documentation/1.3/com/jModule/util/package-use.html create mode 100644 documentation/1.3/constant-values.html create mode 100644 documentation/1.3/deprecated-list.html create mode 100644 documentation/1.3/help-doc.html create mode 100644 documentation/1.3/index-files/index-1.html create mode 100644 documentation/1.3/index-files/index-10.html create mode 100644 documentation/1.3/index-files/index-11.html create mode 100644 documentation/1.3/index-files/index-2.html create mode 100644 documentation/1.3/index-files/index-3.html create mode 100644 documentation/1.3/index-files/index-4.html create mode 100644 documentation/1.3/index-files/index-5.html create mode 100644 documentation/1.3/index-files/index-6.html create mode 100644 documentation/1.3/index-files/index-7.html create mode 100644 documentation/1.3/index-files/index-8.html create mode 100644 documentation/1.3/index-files/index-9.html create mode 100644 documentation/1.3/index.html create mode 100644 documentation/1.3/overview-frame.html create mode 100644 documentation/1.3/overview-summary.html create mode 100644 documentation/1.3/overview-tree.html create mode 100644 documentation/1.3/package-frame.html create mode 100644 documentation/1.3/package-list create mode 100644 documentation/1.3/package-summary.html create mode 100644 documentation/1.3/package-tree.html create mode 100644 documentation/1.3/package-use.html create mode 100644 documentation/1.3/script.js create mode 100644 documentation/1.3/stylesheet.css diff --git a/documentation/1.3/ExampleApp.html b/documentation/1.3/ExampleApp.html new file mode 100644 index 0000000..cbbd2a7 --- /dev/null +++ b/documentation/1.3/ExampleApp.html @@ -0,0 +1,270 @@ + + + + + +ExampleApp + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+

Class ExampleApp

+
+
+ +
+
    +
  • +
    +
    +
    public class ExampleApp
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      ExampleApp() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static voidmain(java.lang.String[] args) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ExampleApp

        +
        public ExampleApp()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        main

        +
        public static void main(java.lang.String[] args)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/documentation/1.3/allclasses-frame.html b/documentation/1.3/allclasses-frame.html new file mode 100644 index 0000000..0c693f9 --- /dev/null +++ b/documentation/1.3/allclasses-frame.html @@ -0,0 +1,27 @@ + + + + + +All Classes + + + + + +

All Classes

+
+ +
+ + diff --git a/documentation/1.3/allclasses-noframe.html b/documentation/1.3/allclasses-noframe.html new file mode 100644 index 0000000..66927ed --- /dev/null +++ b/documentation/1.3/allclasses-noframe.html @@ -0,0 +1,27 @@ + + + + + +All Classes + + + + + +

All Classes

+
+ +
+ + diff --git a/documentation/1.3/class-use/ExampleApp.html b/documentation/1.3/class-use/ExampleApp.html new file mode 100644 index 0000000..d44aade --- /dev/null +++ b/documentation/1.3/class-use/ExampleApp.html @@ -0,0 +1,124 @@ + + + + + +Uses of Class ExampleApp + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
ExampleApp

+
+
No usage of ExampleApp
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/documentation/1.3/com/jModule/def/BoundedCommand.html b/documentation/1.3/com/jModule/def/BoundedCommand.html new file mode 100644 index 0000000..8671939 --- /dev/null +++ b/documentation/1.3/com/jModule/def/BoundedCommand.html @@ -0,0 +1,311 @@ + + + + + +BoundedCommand + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.jModule.def
+

Class BoundedCommand

+
+
+ +
+
    +
  • +
    +
    +
    public class BoundedCommand
+extends IndefiniteCommand
    +
    Represents a command with a certain minimum and maximum number of parameters. + This subclass of IndefCommand can either be instantiated with (name, + description, logic, min) to leave the maximum bound unspecified or (name, + description, logic, min, max) to define both bounds of the range.
    +
    +
    Version:
    +
    1.3.0
    +
    Author:
    +
    Pierce Kelaita
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        BoundedCommand

        +
        public BoundedCommand(java.lang.String name,
+                      java.lang.String description,
+                      CommandLogic logic,
+                      int min)
        +
        Construcs a bounded command with a minimum number of parameters
        +
        +
        Parameters:
        +
        name - Command name
        +
        description - Command description
        +
        logic - Command logic
        +
        min - Minimum number of parameters
        +
        +
        • +
      + + + +
        +
      • +

        BoundedCommand

        +
        public BoundedCommand(java.lang.String name,
+                      java.lang.String description,
+                      CommandLogic logic,
+                      int min,
+                      int max)
        +
        Construcs a bounded command with a minimum and maximum number of parameters
        +
        +
        Parameters:
        +
        name - Command name
        +
        description - Command description
        +
        logic - Command logic
        +
        min - Minimum number of parameters
        +
        max - Maximum number of paramters
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/documentation/1.3/com/jModule/def/Command.html b/documentation/1.3/com/jModule/def/Command.html new file mode 100644 index 0000000..b76446d --- /dev/null +++ b/documentation/1.3/com/jModule/def/Command.html @@ -0,0 +1,445 @@ + + + + + +Command + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.jModule.def
+

Class Command

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    IndefiniteCommand
    +
    +
    +
    +
    public class Command
+extends java.lang.Object
    +
    Represents a possible command. A command can have multiple references, or + ways to call it from the command line. For example, a "find" command that can + be accessed by typing 'find' or just 'fd' on the command line would have 'fd' + as an alternate reference. A command can also have any number of defined + parameters and command-specific logic to process the given parameters. +

    + A command's logic and possible parameters are defined by writing a logic + class extending CommandLogic. For more information about CommandLogic, + consult the CommandLogic documentation

    +
    +
    Version:
    +
    1.3.0
    +
    Author:
    +
    Pierce Kelaita
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Command(java.lang.String name, + java.lang.String description, + CommandLogic logic) +
      Sets the name of the command function (for example, "find" or "grep") and + inherits parameters from command logic, if any.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      voidaddReference(java.lang.String reference) +
      Adds a possible reference to the command
      +
      voidappendUsage(java.lang.String append) +
      Adds additional information to the command's usage info
      +
      java.lang.StringgetDefaultReference() 
      java.lang.StringgetDescription() 
      java.lang.StringgetName() 
      java.util.ArrayList<java.lang.String>getReferences() 
      java.lang.StringgetUsage() +
      Gives the correct usage in a standard, user-friendly format
      +
      voidresetUsage(java.lang.String reset) +
      Replaces the command's usage info with a given String
      +
      voidrun(java.lang.String[] args) +
      Runs the command logic with the given arguments
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Command

        +
        public Command(java.lang.String name,
+               java.lang.String description,
+               CommandLogic logic)
        +
        Sets the name of the command function (for example, "find" or "grep") and + inherits parameters from command logic, if any. Sets the default reference + based on the command's name
        +
        +
        Parameters:
        +
        name - Command name
        +
        description - Command description
        +
        logic - Command logic
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        • +
      + + + +
        +
      • +

        getDefaultReference

        +
        public java.lang.String getDefaultReference()
        +
        • +
      + + + +
        +
      • +

        getReferences

        +
        public java.util.ArrayList<java.lang.String> getReferences()
        +
        • +
      + + + +
        +
      • +

        addReference

        +
        public void addReference(java.lang.String reference)
        +
        Adds a possible reference to the command
        +
        +
        Parameters:
        +
        reference -
        +
        +
        • +
      + + + +
        +
      • +

        getUsage

        +
        public java.lang.String getUsage()
        +
        Gives the correct usage in a standard, user-friendly format
        +
        +
        Returns:
        +
        usage statment
        +
        +
        • +
      + + + +
        +
      • +

        appendUsage

        +
        public void appendUsage(java.lang.String append)
        +
        Adds additional information to the command's usage info
        +
        +
        Parameters:
        +
        append - Information to append to usage
        +
        +
        • +
      + + + +
        +
      • +

        resetUsage

        +
        public void resetUsage(java.lang.String reset)
        +
        Replaces the command's usage info with a given String
        +
        +
        Parameters:
        +
        reset - New usage info to display
        +
        +
        • +
      + + + +
        +
      • +

        run

        +
        public void run(java.lang.String[] args)
        +
        Runs the command logic with the given arguments
        +
        +
        Parameters:
        +
        args - Command-line arguments
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/documentation/1.3/com/jModule/def/CommandLogic.html b/documentation/1.3/com/jModule/def/CommandLogic.html new file mode 100644 index 0000000..1ccb477 --- /dev/null +++ b/documentation/1.3/com/jModule/def/CommandLogic.html @@ -0,0 +1,389 @@ + + + + + +CommandLogic + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.jModule.def
+

Class CommandLogic

+
+
+ +
+
    +
  • +
    +
    +
    public abstract class CommandLogic
+extends java.lang.Object
    +
    Classes extending this class can define the logic for commands based on user + input, if given. You can also define the standard parameters for your command + logic. Subclasses of this class are taken as a parameter when instantiating a + command
    +
    +
    Version:
    +
    1.3.0
    +
    Author:
    +
    Pierce Kelaita
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      CommandLogic() 
      CommandLogic(java.lang.String[] params) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      CommandLogicaddOption(Option t) +
      Adds a possible option to the command.
      +
      abstract voidexecute(java.lang.String[] args) +
      Override this method to define the logic for a command.
      +
      java.util.ArrayList<Option>getOptions() 
      java.lang.String[]getParams() 
      booleanonOption(char flag) +
      Use this method in an if-statement as such:
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CommandLogic

        +
        public CommandLogic()
        +
        • +
      + + + +
        +
      • +

        CommandLogic

        +
        public CommandLogic(java.lang.String[] params)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getOptions

        +
        public java.util.ArrayList<Option> getOptions()
        +
        • +
      + + + +
        +
      • +

        getParams

        +
        public java.lang.String[] getParams()
        +
        • +
      + + + +
        +
      • +

        execute

        +
        public abstract void execute(java.lang.String[] args)
        +
        Override this method to define the logic for a command.
        +
        +
        Parameters:
        +
        args - Command-line arguments
        +
        +
        • +
      + + + +
        +
      • +

        onOption

        +
        public boolean onOption(char flag)
        +
        Use this method in an if-statement as such:
        + + 
        + 
+  @Override
+ public void execute() {
+ ...
+        if (onOption('a')) {
+                 // behavior with option 'a'
+        }
+        if (onOption('b')) {
+                 // behavior with option 'b'
+        }
+ }
+ 
+
        + +
        to signify the execution of the command when different options + are called in addition to the command's parameters.
        +
        +
        Parameters:
        +
        flag - The option's one-character reference (Example: "-a" or "-b")
        +
        Returns:
        +
        true if the option exists and is called either by its + flag or one of its references, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        addOption

        +
        public CommandLogic addOption(Option t)
        +
        Adds a possible option to the command.
        +
        +
        Parameters:
        +
        t - Default flag to call the option
        +
        Returns:
        +
        This instance of CommandLogic
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/documentation/1.3/com/jModule/def/IndefiniteCommand.html b/documentation/1.3/com/jModule/def/IndefiniteCommand.html new file mode 100644 index 0000000..40896eb --- /dev/null +++ b/documentation/1.3/com/jModule/def/IndefiniteCommand.html @@ -0,0 +1,266 @@ + + + + + +IndefiniteCommand + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.jModule.def
+

Class IndefiniteCommand

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    BoundedCommand
    +
    +
    +
    +
    public class IndefiniteCommand
+extends Command
    +
    Represents a Command with an indefinite number of parameters. These commands + can be called from the command line with any number of parameters, including + zero.
    +
    +
    Version:
    +
    1.3.0
    +
    Author:
    +
    Pierce Kelaita
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        IndefiniteCommand

        +
        public IndefiniteCommand(java.lang.String name,
+                         java.lang.String description,
+                         CommandLogic logic)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/documentation/1.3/com/jModule/def/Option.html b/documentation/1.3/com/jModule/def/Option.html new file mode 100644 index 0000000..1c55279 --- /dev/null +++ b/documentation/1.3/com/jModule/def/Option.html @@ -0,0 +1,331 @@ + + + + + +Option + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.jModule.def
+

Class Option

+
+
+ +
+
    +
  • +
    +
    +
    public class Option
+extends java.lang.Object
    +
    Represents an option that affects a command's behavior. These are, by nature, + optional and do not count as a parameter of a command. Each option is called + by a unique single-char flag, signified by a dash (for example, -v).
    +
    +
    Version:
    +
    1.3.0
    +
    Author:
    +
    Pierce Kelaita
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Option(char flag, + java.lang.String description) 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      OptionaddReference(java.lang.String reference) +
      Adds a possible reference to the option.
      +
      java.lang.StringgetDescription() 
      java.lang.StringgetFlag() 
      java.util.ArrayList<java.lang.String>getReferences() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Option

        +
        public Option(char flag,
+              java.lang.String description)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getReferences

        +
        public java.util.ArrayList<java.lang.String> getReferences()
        +
        • +
      + + + +
        +
      • +

        getFlag

        +
        public java.lang.String getFlag()
        +
        • +
      + + + +
        +
      • +

        getDescription

        +
        public java.lang.String getDescription()
        +
        • +
      + + + +
        +
      • +

        addReference

        +
        public Option addReference(java.lang.String reference)
        +
        Adds a possible reference to the option. References are signaled by a double + dash and can be multiple characters (for example, --verbose).
        +
        +
        Parameters:
        +
        reference - String to reference option
        +
        Returns:
        +
        Instance of this option with added reference
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/documentation/1.3/com/jModule/def/class-use/BoundedCommand.html b/documentation/1.3/com/jModule/def/class-use/BoundedCommand.html new file mode 100644 index 0000000..137f7ac --- /dev/null +++ b/documentation/1.3/com/jModule/def/class-use/BoundedCommand.html @@ -0,0 +1,124 @@ + + + + + +Uses of Class com.jModule.def.BoundedCommand + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.jModule.def.BoundedCommand

+
+
No usage of com.jModule.def.BoundedCommand
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/documentation/1.3/com/jModule/def/class-use/Command.html b/documentation/1.3/com/jModule/def/class-use/Command.html new file mode 100644 index 0000000..548b362 --- /dev/null +++ b/documentation/1.3/com/jModule/def/class-use/Command.html @@ -0,0 +1,210 @@ + + + + + +Uses of Class com.jModule.def.Command + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.jModule.def.Command

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/documentation/1.3/com/jModule/def/class-use/CommandLogic.html b/documentation/1.3/com/jModule/def/class-use/CommandLogic.html new file mode 100644 index 0000000..991307e --- /dev/null +++ b/documentation/1.3/com/jModule/def/class-use/CommandLogic.html @@ -0,0 +1,204 @@ + + + + + +Uses of Class com.jModule.def.CommandLogic + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.jModule.def.CommandLogic

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/documentation/1.3/com/jModule/def/class-use/IndefiniteCommand.html b/documentation/1.3/com/jModule/def/class-use/IndefiniteCommand.html new file mode 100644 index 0000000..990b47c --- /dev/null +++ b/documentation/1.3/com/jModule/def/class-use/IndefiniteCommand.html @@ -0,0 +1,166 @@ + + + + + +Uses of Class com.jModule.def.IndefiniteCommand + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.jModule.def.IndefiniteCommand

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/documentation/1.3/com/jModule/def/class-use/Option.html b/documentation/1.3/com/jModule/def/class-use/Option.html new file mode 100644 index 0000000..9ea6dc3 --- /dev/null +++ b/documentation/1.3/com/jModule/def/class-use/Option.html @@ -0,0 +1,194 @@ + + + + + +Uses of Class com.jModule.def.Option + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.jModule.def.Option

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/documentation/1.3/com/jModule/def/package-frame.html b/documentation/1.3/com/jModule/def/package-frame.html new file mode 100644 index 0000000..7f5733e --- /dev/null +++ b/documentation/1.3/com/jModule/def/package-frame.html @@ -0,0 +1,24 @@ + + + + + +com.jModule.def + + + + + +

com.jModule.def

+
+

Classes

+ +
+ + diff --git a/documentation/1.3/com/jModule/def/package-summary.html b/documentation/1.3/com/jModule/def/package-summary.html new file mode 100644 index 0000000..dab957e --- /dev/null +++ b/documentation/1.3/com/jModule/def/package-summary.html @@ -0,0 +1,169 @@ + + + + + +com.jModule.def + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.jModule.def

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/documentation/1.3/com/jModule/def/package-tree.html b/documentation/1.3/com/jModule/def/package-tree.html new file mode 100644 index 0000000..d554e0b --- /dev/null +++ b/documentation/1.3/com/jModule/def/package-tree.html @@ -0,0 +1,147 @@ + + + + + +com.jModule.def Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.jModule.def

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/documentation/1.3/com/jModule/def/package-use.html b/documentation/1.3/com/jModule/def/package-use.html new file mode 100644 index 0000000..6c7f8ad --- /dev/null +++ b/documentation/1.3/com/jModule/def/package-use.html @@ -0,0 +1,196 @@ + + + + + +Uses of Package com.jModule.def + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
com.jModule.def

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/documentation/1.3/com/jModule/exec/ConsoleClient.html b/documentation/1.3/com/jModule/exec/ConsoleClient.html new file mode 100644 index 0000000..414a74c --- /dev/null +++ b/documentation/1.3/com/jModule/exec/ConsoleClient.html @@ -0,0 +1,540 @@ + + + + + +ConsoleClient + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.jModule.exec
+

Class ConsoleClient

+
+
+ +
+
    +
  • +
    +
    +
    public class ConsoleClient
+extends java.lang.Object
    +
    Builds and runs a multi-module command line interface. + + Please note: This class takes user input by toggling the console between raw + input and regular input mode. As of version 1.0.2, this client only + officially supports *nix terminals. The client has not yet been tested on + windows terminals.
    +
    +
    Version:
    +
    1.2.1
    +
    Author:
    +
    Pierce Kelaita
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      ConsoleClient(java.lang.String appname, + Module homeModule) +
      Sets the name of the app and the starting module
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      voidaddModule(Module m) +
      Adds a possible module to the client.
      +
      voidaddShutdownHook(java.lang.Thread onShutdown) +
      Adds a proccess to run when the app shuts down.
      +
      voidenableAlerts(boolean enabled) +
      Sets whether the client will trigger the system's default alert sound when + the user performs actions that cannot have a result.
      +
      voidenableHistoryIndexDisplay(boolean enabled) +
      Sets whether the client will display the history index in the prompt.
      +
      voidenableHistoryLogging(boolean enabled) +
      Sets whether the client will log history of user commands.
      +
      voidenableTabCompletion(boolean enabled) +
      Sets whether the client will be able to toggle through command history using + the tab key
      +
      voidremoveModule(Module m) +
      Removes a possible module from the client.
      +
      voidrunConsole() +
      Runs the console application accross all modules, starting from the home + module
      +
      voidsetModuleSeparator(java.lang.String separator) +
      Sets the character(s) that will be shown between the app name and the module + in the prompt display.
      +
      voidsetPromptDisplayName(java.lang.String name) +
      Sets the app name that will show on the prompt display.
      +
      voidsetPromptSeparator(java.lang.String separator) +
      Sets the character(s) that will come up at the end of the prompt on the CLI + to separate the prompt from the user input.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ConsoleClient

        +
        public ConsoleClient(java.lang.String appname,
+                     Module homeModule)
        +
        Sets the name of the app and the starting module
        +
        +
        Parameters:
        +
        appname - The name of the console application
        +
        homeModule - The default module that is loaded when user first starts up + application
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setPromptSeparator

        +
        public void setPromptSeparator(java.lang.String separator)
        +
        Sets the character(s) that will come up at the end of the prompt on the CLI + to separate the prompt from the user input. By default, this separator is + "$". +

        + The following examples show two prompts with the same settings but different + prompt seprators: +

        + + AppName: module$      - separator is + set to "$" (default setting)
        + AppName: module>      - separator is + set to ">"
        + AppName: module >    - separator is set to + " >"

        +
        +
        Parameters:
        +
        separator -
        +
        +
        • +
      + + + +
        +
      • +

        setModuleSeparator

        +
        public void setModuleSeparator(java.lang.String separator)
        +
        Sets the character(s) that will be shown between the app name and the module + in the prompt display. By default, this separator is ": " - a colon with a + space after it. Be advised that this separator will only be displayed if the + client has multiple modules. +

        + The following examples show two prompts with the same settings but different + module seprators: +

        + + AppName: module 0$    - separator is set to + ": " (default setting)
        + AppName/ module 0$    - separator is set to + "/ "
        + AppName/module 0$      - separator is + set to "/"

        +
        +
        Parameters:
        +
        separator -
        +
        +
        • +
      + + + +
        +
      • +

        enableHistoryLogging

        +
        public void enableHistoryLogging(boolean enabled)
        +
        Sets whether the client will log history of user commands. This value is set + to false by default.
        +
        +
        Parameters:
        +
        historyEnabled - if true, client will log command history
        +
        +
        • +
      + + + +
        +
      • +

        enableHistoryIndexDisplay

        +
        public void enableHistoryIndexDisplay(boolean enabled)
        +
        Sets whether the client will display the history index in the prompt. This + can only be enabled if history logging is enabled and is set to false by + default.
        +
        +
        Parameters:
        +
        enabled - if true, client will display history index in prompt
        +
        +
        • +
      + + + +
        +
      • +

        enableTabCompletion

        +
        public void enableTabCompletion(boolean enabled)
        +
        Sets whether the client will be able to toggle through command history using + the tab key
        +
        +
        Parameters:
        +
        historyEnabled - if true, client will log command history
        +
        +
        • +
      + + + +
        +
      • +

        enableAlerts

        +
        public void enableAlerts(boolean enabled)
        +
        Sets whether the client will trigger the system's default alert sound when + the user performs actions that cannot have a result. (For example, pressing + delete when there are no input characters on the line)
        +
        +
        Parameters:
        +
        enabled - if true, client will trigger system alerts
        +
        +
        • +
      + + + +
        +
      • +

        setPromptDisplayName

        +
        public void setPromptDisplayName(java.lang.String name)
        +
        Sets the app name that will show on the prompt display. By default, this + value is null, and the prompt display shows the user-given app name with its + spaces removed.
        +
        +
        Parameters:
        +
        name -
        +
        +
        • +
      + + + +
        +
      • +

        addShutdownHook

        +
        public void addShutdownHook(java.lang.Thread onShutdown)
        +
        Adds a proccess to run when the app shuts down. Define your proccess by + overriding the method run() in java.lang.Thread.
        +
        +
        Parameters:
        +
        onShutdown - Thread containing process to run on shutdown
        +
        +
        • +
      + + + +
        +
      • +

        addModule

        +
        public void addModule(Module m)
        +
        Adds a possible module to the client. The user can switch to this module by + typing its name in the CLI
        +
        +
        Parameters:
        +
        m - Module to add
        +
        +
        • +
      + + + +
        +
      • +

        removeModule

        +
        public void removeModule(Module m)
        +
        Removes a possible module from the client.
        +
        +
        Parameters:
        +
        m - Module to remove
        +
        +
        • +
      + + + +
        +
      • +

        runConsole

        +
        public void runConsole()
        +
        Runs the console application accross all modules, starting from the home + module
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/documentation/1.3/com/jModule/exec/Module.html b/documentation/1.3/com/jModule/exec/Module.html new file mode 100644 index 0000000..590e54a --- /dev/null +++ b/documentation/1.3/com/jModule/exec/Module.html @@ -0,0 +1,383 @@ + + + + + +Module + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.jModule.exec
+

Class Module

+
+
+ +
+
    +
  • +
    +
    +
    public class Module
+extends java.lang.Object
    +
    Represents a module holding a group of possible commands relating to a + certain function
    +
    +
    Version:
    +
    1.2.0
    +
    Author:
    +
    Pierce Kelaita
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Module(java.lang.String name) +
      Sets the name and the display promt that will come up on the CLI
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      voidaddCommand(Command c) +
      Adds to a list of commands that are only accessible when the user has + switched to this module.
      +
      voidappendHelpPage(java.lang.String append) +
      Adds additional information to the module's help page
      +
      java.util.ArrayList<Command>getCommands() 
      java.lang.StringgetName() 
      java.util.ArrayList<java.lang.String>getReferences() +
      Returns a list with the default reference of each command conatined within + the module, plus 'help' and 'exit'
      +
      voidresetHelpPage(java.lang.String reset) +
      Replaces the module's help page with a given String
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Module

        +
        public Module(java.lang.String name)
        +
        Sets the name and the display promt that will come up on the CLI
        +
        +
        Parameters:
        +
        name -
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getName

        +
        public java.lang.String getName()
        +
        • +
      + + + +
        +
      • +

        getCommands

        +
        public java.util.ArrayList<Command> getCommands()
        +
        • +
      + + + +
        +
      • +

        addCommand

        +
        public void addCommand(Command c)
        +
        Adds to a list of commands that are only accessible when the user has + switched to this module.
        +
        +
        Parameters:
        +
        c -
        +
        +
        • +
      + + + +
        +
      • +

        appendHelpPage

        +
        public void appendHelpPage(java.lang.String append)
        +
        Adds additional information to the module's help page
        +
        +
        Parameters:
        +
        append - Information to append to help page
        +
        +
        • +
      + + + +
        +
      • +

        resetHelpPage

        +
        public void resetHelpPage(java.lang.String reset)
        +
        Replaces the module's help page with a given String
        +
        +
        Parameters:
        +
        reset - New help page to display
        +
        +
        • +
      + + + +
        +
      • +

        getReferences

        +
        public java.util.ArrayList<java.lang.String> getReferences()
        +
        Returns a list with the default reference of each command conatined within + the module, plus 'help' and 'exit'
        +
        +
        Returns:
        +
        references
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/documentation/1.3/com/jModule/exec/class-use/ConsoleClient.html b/documentation/1.3/com/jModule/exec/class-use/ConsoleClient.html new file mode 100644 index 0000000..674475d --- /dev/null +++ b/documentation/1.3/com/jModule/exec/class-use/ConsoleClient.html @@ -0,0 +1,124 @@ + + + + + +Uses of Class com.jModule.exec.ConsoleClient + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.jModule.exec.ConsoleClient

+
+
No usage of com.jModule.exec.ConsoleClient
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/documentation/1.3/com/jModule/exec/class-use/Module.html b/documentation/1.3/com/jModule/exec/class-use/Module.html new file mode 100644 index 0000000..5b49747 --- /dev/null +++ b/documentation/1.3/com/jModule/exec/class-use/Module.html @@ -0,0 +1,186 @@ + + + + + +Uses of Class com.jModule.exec.Module + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.jModule.exec.Module

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/documentation/1.3/com/jModule/exec/package-frame.html b/documentation/1.3/com/jModule/exec/package-frame.html new file mode 100644 index 0000000..4dbb20b --- /dev/null +++ b/documentation/1.3/com/jModule/exec/package-frame.html @@ -0,0 +1,21 @@ + + + + + +com.jModule.exec + + + + + +

com.jModule.exec

+
+

Classes

+ +
+ + diff --git a/documentation/1.3/com/jModule/exec/package-summary.html b/documentation/1.3/com/jModule/exec/package-summary.html new file mode 100644 index 0000000..d26caac --- /dev/null +++ b/documentation/1.3/com/jModule/exec/package-summary.html @@ -0,0 +1,151 @@ + + + + + +com.jModule.exec + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.jModule.exec

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/documentation/1.3/com/jModule/exec/package-tree.html b/documentation/1.3/com/jModule/exec/package-tree.html new file mode 100644 index 0000000..395d98d --- /dev/null +++ b/documentation/1.3/com/jModule/exec/package-tree.html @@ -0,0 +1,138 @@ + + + + + +com.jModule.exec Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.jModule.exec

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/documentation/1.3/com/jModule/exec/package-use.html b/documentation/1.3/com/jModule/exec/package-use.html new file mode 100644 index 0000000..abd9824 --- /dev/null +++ b/documentation/1.3/com/jModule/exec/package-use.html @@ -0,0 +1,160 @@ + + + + + +Uses of Package com.jModule.exec + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
com.jModule.exec

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/documentation/1.3/com/jModule/util/ConsoleUtil.html b/documentation/1.3/com/jModule/util/ConsoleUtil.html new file mode 100644 index 0000000..b58f419 --- /dev/null +++ b/documentation/1.3/com/jModule/util/ConsoleUtil.html @@ -0,0 +1,282 @@ + + + + + +ConsoleUtil + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.jModule.util
+

Class ConsoleUtil

+
+
+ +
+
    +
  • +
    +
    +
    public class ConsoleUtil
+extends java.lang.Object
    +
    Adapted from Graham King's "Non-Blocking Console Input in Python and Java" + https://www.darkcoding.net/software/non-blocking-console-io-is-not-possible/ + + Toggles the terminal between raw input mode (reading input character by + character) and regular input mode (reading input line by line)
    +
    +
    Version:
    +
    1.2.2
    +
    Author:
    +
    Pierce Kelaita
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static voidsetTerminalRawInput() +
      Sets terminal to raw input mode.
      +
      static voidsetTerminalRegularInput() +
      Sets terminal to regular input mode
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setTerminalRawInput

        +
        public static void setTerminalRawInput()
+                                throws java.io.IOException,
+                                       java.lang.InterruptedException
        +
        Sets terminal to raw input mode. You can't run this twice in a row or else + you'll lock your terminal in raw input mode!
        +
        +
        Throws:
        +
        java.io.IOException
        +
        java.lang.InterruptedException
        +
        +
        • +
      + + + +
        +
      • +

        setTerminalRegularInput

        +
        public static void setTerminalRegularInput()
+                                    throws java.io.IOException,
+                                           java.lang.InterruptedException
        +
        Sets terminal to regular input mode
        +
        +
        Throws:
        +
        java.io.IOException
        +
        java.lang.InterruptedException
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/documentation/1.3/com/jModule/util/InputUtil.html b/documentation/1.3/com/jModule/util/InputUtil.html new file mode 100644 index 0000000..dcd2980 --- /dev/null +++ b/documentation/1.3/com/jModule/util/InputUtil.html @@ -0,0 +1,329 @@ + + + + + +InputUtil + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.jModule.util
+

Class InputUtil

+
+
+ +
+
    +
  • +
    +
    +
    public class InputUtil
+extends java.lang.Object
    +
    Utility class to process user input on *nix terminals. This class is + currently untested on Windows terminals.
    +
    +
    Version:
    +
    1.2.2
    +
    Author:
    +
    Pierce Kelaita
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static voidaddHistory(java.lang.String entry) 
      static java.util.ArrayList<java.lang.String>getHistory() 
      static java.lang.StringpromptUserInput(java.util.ArrayList<java.lang.String> commandReferences, + java.lang.String prompt) +
      Takes in user input and prints result of each character.
      +
      static voidsetAlertsEnabled(boolean enabled) 
      static voidsetHistoryEnabled(boolean enabled) 
      static voidsetTabCompletionEnabled(boolean enabled) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setHistoryEnabled

        +
        public static void setHistoryEnabled(boolean enabled)
        +
        • +
      + + + +
        +
      • +

        setTabCompletionEnabled

        +
        public static void setTabCompletionEnabled(boolean enabled)
        +
        • +
      + + + +
        +
      • +

        setAlertsEnabled

        +
        public static void setAlertsEnabled(boolean enabled)
        +
        • +
      + + + +
        +
      • +

        getHistory

        +
        public static java.util.ArrayList<java.lang.String> getHistory()
        +
        • +
      + + + +
        +
      • +

        addHistory

        +
        public static void addHistory(java.lang.String entry)
        +
        • +
      + + + +
        +
      • +

        promptUserInput

        +
        public static java.lang.String promptUserInput(java.util.ArrayList<java.lang.String> commandReferences,
+                                               java.lang.String prompt)
+                                        throws java.io.IOException,
+                                               java.lang.InterruptedException
        +
        Takes in user input and prints result of each character. Currently able to + process all standard chars plus 'enter' and 'backspace' keystrokes.
        +
        +
        Parameters:
        +
        commandReferences - possible references that can be toggled with the 'tab' key
        +
        prompt - the first String to come up on the CLI to prompt the user for + input
        +
        Returns:
        +
        result of user input
        +
        Throws:
        +
        java.io.IOException
        +
        java.lang.InterruptedException
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/documentation/1.3/com/jModule/util/class-use/ConsoleUtil.html b/documentation/1.3/com/jModule/util/class-use/ConsoleUtil.html new file mode 100644 index 0000000..377267b --- /dev/null +++ b/documentation/1.3/com/jModule/util/class-use/ConsoleUtil.html @@ -0,0 +1,124 @@ + + + + + +Uses of Class com.jModule.util.ConsoleUtil + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.jModule.util.ConsoleUtil

+
+
No usage of com.jModule.util.ConsoleUtil
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/documentation/1.3/com/jModule/util/class-use/InputUtil.html b/documentation/1.3/com/jModule/util/class-use/InputUtil.html new file mode 100644 index 0000000..3fc32c9 --- /dev/null +++ b/documentation/1.3/com/jModule/util/class-use/InputUtil.html @@ -0,0 +1,124 @@ + + + + + +Uses of Class com.jModule.util.InputUtil + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.jModule.util.InputUtil

+
+
No usage of com.jModule.util.InputUtil
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/documentation/1.3/com/jModule/util/package-frame.html b/documentation/1.3/com/jModule/util/package-frame.html new file mode 100644 index 0000000..2db7ba2 --- /dev/null +++ b/documentation/1.3/com/jModule/util/package-frame.html @@ -0,0 +1,21 @@ + + + + + +com.jModule.util + + + + + +

com.jModule.util

+
+

Classes

+ +
+ + diff --git a/documentation/1.3/com/jModule/util/package-summary.html b/documentation/1.3/com/jModule/util/package-summary.html new file mode 100644 index 0000000..680b7c9 --- /dev/null +++ b/documentation/1.3/com/jModule/util/package-summary.html @@ -0,0 +1,154 @@ + + + + + +com.jModule.util + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.jModule.util

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/documentation/1.3/com/jModule/util/package-tree.html b/documentation/1.3/com/jModule/util/package-tree.html new file mode 100644 index 0000000..75b0e95 --- /dev/null +++ b/documentation/1.3/com/jModule/util/package-tree.html @@ -0,0 +1,138 @@ + + + + + +com.jModule.util Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.jModule.util

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/documentation/1.3/com/jModule/util/package-use.html b/documentation/1.3/com/jModule/util/package-use.html new file mode 100644 index 0000000..4b4023c --- /dev/null +++ b/documentation/1.3/com/jModule/util/package-use.html @@ -0,0 +1,124 @@ + + + + + +Uses of Package com.jModule.util + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
com.jModule.util

+
+
No usage of com.jModule.util
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/documentation/1.3/constant-values.html b/documentation/1.3/constant-values.html new file mode 100644 index 0000000..aab58b1 --- /dev/null +++ b/documentation/1.3/constant-values.html @@ -0,0 +1,124 @@ + + + + + +Constant Field Values + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Constant Field Values

+

Contents

+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/documentation/1.3/deprecated-list.html b/documentation/1.3/deprecated-list.html new file mode 100644 index 0000000..ecf9482 --- /dev/null +++ b/documentation/1.3/deprecated-list.html @@ -0,0 +1,124 @@ + + + + + +Deprecated List + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Deprecated API

+

Contents

+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/documentation/1.3/help-doc.html b/documentation/1.3/help-doc.html new file mode 100644 index 0000000..e8faf25 --- /dev/null +++ b/documentation/1.3/help-doc.html @@ -0,0 +1,229 @@ + + + + + +API Help + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

How This API Document Is Organized

+
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
+
+
+ +This help file applies to API documentation generated using the standard doclet.
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/documentation/1.3/index-files/index-1.html b/documentation/1.3/index-files/index-1.html new file mode 100644 index 0000000..7f55119 --- /dev/null +++ b/documentation/1.3/index-files/index-1.html @@ -0,0 +1,162 @@ + + + + + +A-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A B C E G I M O P R S  + + +

A

+
+
addCommand(Command) - Method in class com.jModule.exec.Module
+
+
Adds to a list of commands that are only accessible when the user has + switched to this module.
+
+
addHistory(String) - Static method in class com.jModule.util.InputUtil
+
 
+
addModule(Module) - Method in class com.jModule.exec.ConsoleClient
+
+
Adds a possible module to the client.
+
+
addOption(Option) - Method in class com.jModule.def.CommandLogic
+
+
Adds a possible option to the command.
+
+
addReference(String) - Method in class com.jModule.def.Command
+
+
Adds a possible reference to the command
+
+
addReference(String) - Method in class com.jModule.def.Option
+
+
Adds a possible reference to the option.
+
+
addShutdownHook(Thread) - Method in class com.jModule.exec.ConsoleClient
+
+
Adds a proccess to run when the app shuts down.
+
+
appendHelpPage(String) - Method in class com.jModule.exec.Module
+
+
Adds additional information to the module's help page
+
+
appendUsage(String) - Method in class com.jModule.def.Command
+
+
Adds additional information to the command's usage info
+
+
+A B C E G I M O P R S 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/documentation/1.3/index-files/index-10.html b/documentation/1.3/index-files/index-10.html new file mode 100644 index 0000000..a111004 --- /dev/null +++ b/documentation/1.3/index-files/index-10.html @@ -0,0 +1,148 @@ + + + + + +R-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A B C E G I M O P R S  + + +

R

+
+
removeModule(Module) - Method in class com.jModule.exec.ConsoleClient
+
+
Removes a possible module from the client.
+
+
resetHelpPage(String) - Method in class com.jModule.exec.Module
+
+
Replaces the module's help page with a given String
+
+
resetUsage(String) - Method in class com.jModule.def.Command
+
+
Replaces the command's usage info with a given String
+
+
run(String[]) - Method in class com.jModule.def.Command
+
+
Runs the command logic with the given arguments
+
+
runConsole() - Method in class com.jModule.exec.ConsoleClient
+
+
Runs the console application accross all modules, starting from the home + module
+
+
+A B C E G I M O P R S 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/documentation/1.3/index-files/index-11.html b/documentation/1.3/index-files/index-11.html new file mode 100644 index 0000000..bbcf96a --- /dev/null +++ b/documentation/1.3/index-files/index-11.html @@ -0,0 +1,155 @@ + + + + + +S-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A B C E G I M O P R S  + + +

S

+
+
setAlertsEnabled(boolean) - Static method in class com.jModule.util.InputUtil
+
 
+
setHistoryEnabled(boolean) - Static method in class com.jModule.util.InputUtil
+
 
+
setModuleSeparator(String) - Method in class com.jModule.exec.ConsoleClient
+
+
Sets the character(s) that will be shown between the app name and the module + in the prompt display.
+
+
setPromptDisplayName(String) - Method in class com.jModule.exec.ConsoleClient
+
+
Sets the app name that will show on the prompt display.
+
+
setPromptSeparator(String) - Method in class com.jModule.exec.ConsoleClient
+
+
Sets the character(s) that will come up at the end of the prompt on the CLI + to separate the prompt from the user input.
+
+
setTabCompletionEnabled(boolean) - Static method in class com.jModule.util.InputUtil
+
 
+
setTerminalRawInput() - Static method in class com.jModule.util.ConsoleUtil
+
+
Sets terminal to raw input mode.
+
+
setTerminalRegularInput() - Static method in class com.jModule.util.ConsoleUtil
+
+
Sets terminal to regular input mode
+
+
+A B C E G I M O P R S 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/documentation/1.3/index-files/index-2.html b/documentation/1.3/index-files/index-2.html new file mode 100644 index 0000000..5ac2151 --- /dev/null +++ b/documentation/1.3/index-files/index-2.html @@ -0,0 +1,139 @@ + + + + + +B-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A B C E G I M O P R S  + + +

B

+
+
BoundedCommand - Class in com.jModule.def
+
+
Represents a command with a certain minimum and maximum number of parameters.
+
+
BoundedCommand(String, String, CommandLogic, int) - Constructor for class com.jModule.def.BoundedCommand
+
+
Construcs a bounded command with a minimum number of parameters
+
+
BoundedCommand(String, String, CommandLogic, int, int) - Constructor for class com.jModule.def.BoundedCommand
+
+
Construcs a bounded command with a minimum and maximum number of parameters
+
+
+A B C E G I M O P R S 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/documentation/1.3/index-files/index-3.html b/documentation/1.3/index-files/index-3.html new file mode 100644 index 0000000..371cabd --- /dev/null +++ b/documentation/1.3/index-files/index-3.html @@ -0,0 +1,167 @@ + + + + + +C-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A B C E G I M O P R S  + + +

C

+
+
com.jModule.def - package com.jModule.def
+
 
+
com.jModule.exec - package com.jModule.exec
+
 
+
com.jModule.util - package com.jModule.util
+
 
+
Command - Class in com.jModule.def
+
+
Represents a possible command.
+
+
Command(String, String, CommandLogic) - Constructor for class com.jModule.def.Command
+
+
Sets the name of the command function (for example, "find" or "grep") and + inherits parameters from command logic, if any.
+
+
CommandLogic - Class in com.jModule.def
+
+
Classes extending this class can define the logic for commands based on user + input, if given.
+
+
CommandLogic() - Constructor for class com.jModule.def.CommandLogic
+
 
+
CommandLogic(String[]) - Constructor for class com.jModule.def.CommandLogic
+
 
+
ConsoleClient - Class in com.jModule.exec
+
+
Builds and runs a multi-module command line interface.
+
+
ConsoleClient(String, Module) - Constructor for class com.jModule.exec.ConsoleClient
+
+
Sets the name of the app and the starting module
+
+
ConsoleUtil - Class in com.jModule.util
+
+
Adapted from Graham King's "Non-Blocking Console Input in Python and Java" + https://www.darkcoding.net/software/non-blocking-console-io-is-not-possible/ + + Toggles the terminal between raw input mode (reading input character by + character) and regular input mode (reading input line by line)
+
+
+A B C E G I M O P R S 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/documentation/1.3/index-files/index-4.html b/documentation/1.3/index-files/index-4.html new file mode 100644 index 0000000..0d35685 --- /dev/null +++ b/documentation/1.3/index-files/index-4.html @@ -0,0 +1,149 @@ + + + + + +E-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A B C E G I M O P R S  + + +

E

+
+
enableAlerts(boolean) - Method in class com.jModule.exec.ConsoleClient
+
+
Sets whether the client will trigger the system's default alert sound when + the user performs actions that cannot have a result.
+
+
enableHistoryIndexDisplay(boolean) - Method in class com.jModule.exec.ConsoleClient
+
+
Sets whether the client will display the history index in the prompt.
+
+
enableHistoryLogging(boolean) - Method in class com.jModule.exec.ConsoleClient
+
+
Sets whether the client will log history of user commands.
+
+
enableTabCompletion(boolean) - Method in class com.jModule.exec.ConsoleClient
+
+
Sets whether the client will be able to toggle through command history using + the tab key
+
+
execute(String[]) - Method in class com.jModule.def.CommandLogic
+
+
Override this method to define the logic for a command.
+
+
+A B C E G I M O P R S 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/documentation/1.3/index-files/index-5.html b/documentation/1.3/index-files/index-5.html new file mode 100644 index 0000000..1eb7d25 --- /dev/null +++ b/documentation/1.3/index-files/index-5.html @@ -0,0 +1,160 @@ + + + + + +G-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A B C E G I M O P R S  + + +

G

+
+
getCommands() - Method in class com.jModule.exec.Module
+
 
+
getDefaultReference() - Method in class com.jModule.def.Command
+
 
+
getDescription() - Method in class com.jModule.def.Command
+
 
+
getDescription() - Method in class com.jModule.def.Option
+
 
+
getFlag() - Method in class com.jModule.def.Option
+
 
+
getHistory() - Static method in class com.jModule.util.InputUtil
+
 
+
getName() - Method in class com.jModule.def.Command
+
 
+
getName() - Method in class com.jModule.exec.Module
+
 
+
getOptions() - Method in class com.jModule.def.CommandLogic
+
 
+
getParams() - Method in class com.jModule.def.CommandLogic
+
 
+
getReferences() - Method in class com.jModule.def.Command
+
 
+
getReferences() - Method in class com.jModule.def.Option
+
 
+
getReferences() - Method in class com.jModule.exec.Module
+
+
Returns a list with the default reference of each command conatined within + the module, plus 'help' and 'exit'
+
+
getUsage() - Method in class com.jModule.def.Command
+
+
Gives the correct usage in a standard, user-friendly format
+
+
+A B C E G I M O P R S 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/documentation/1.3/index-files/index-6.html b/documentation/1.3/index-files/index-6.html new file mode 100644 index 0000000..ee9b94c --- /dev/null +++ b/documentation/1.3/index-files/index-6.html @@ -0,0 +1,137 @@ + + + + + +I-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A B C E G I M O P R S  + + +

I

+
+
IndefiniteCommand - Class in com.jModule.def
+
+
Represents a Command with an indefinite number of parameters.
+
+
IndefiniteCommand(String, String, CommandLogic) - Constructor for class com.jModule.def.IndefiniteCommand
+
 
+
InputUtil - Class in com.jModule.util
+
+
Utility class to process user input on *nix terminals.
+
+
+A B C E G I M O P R S 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/documentation/1.3/index-files/index-7.html b/documentation/1.3/index-files/index-7.html new file mode 100644 index 0000000..6aae90c --- /dev/null +++ b/documentation/1.3/index-files/index-7.html @@ -0,0 +1,136 @@ + + + + + +M-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A B C E G I M O P R S  + + +

M

+
+
Module - Class in com.jModule.exec
+
+
Represents a module holding a group of possible commands relating to a + certain function
+
+
Module(String) - Constructor for class com.jModule.exec.Module
+
+
Sets the name and the display promt that will come up on the CLI
+
+
+A B C E G I M O P R S 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/documentation/1.3/index-files/index-8.html b/documentation/1.3/index-files/index-8.html new file mode 100644 index 0000000..ac187f8 --- /dev/null +++ b/documentation/1.3/index-files/index-8.html @@ -0,0 +1,137 @@ + + + + + +O-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A B C E G I M O P R S  + + +

O

+
+
onOption(char) - Method in class com.jModule.def.CommandLogic
+
+
Use this method in an if-statement as such:
+
+
Option - Class in com.jModule.def
+
+
Represents an option that affects a command's behavior.
+
+
Option(char, String) - Constructor for class com.jModule.def.Option
+
 
+
+A B C E G I M O P R S 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/documentation/1.3/index-files/index-9.html b/documentation/1.3/index-files/index-9.html new file mode 100644 index 0000000..54ba75d --- /dev/null +++ b/documentation/1.3/index-files/index-9.html @@ -0,0 +1,131 @@ + + + + + +P-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A B C E G I M O P R S  + + +

P

+
+
promptUserInput(ArrayList<String>, String) - Static method in class com.jModule.util.InputUtil
+
+
Takes in user input and prints result of each character.
+
+
+A B C E G I M O P R S 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/documentation/1.3/index.html b/documentation/1.3/index.html new file mode 100644 index 0000000..6213e0d --- /dev/null +++ b/documentation/1.3/index.html @@ -0,0 +1,75 @@ + + + + + +Generated Documentation (Untitled) + + + + + + + + + +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<h2>Frame Alert</h2> +<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p> + + + diff --git a/documentation/1.3/overview-frame.html b/documentation/1.3/overview-frame.html new file mode 100644 index 0000000..51dccee --- /dev/null +++ b/documentation/1.3/overview-frame.html @@ -0,0 +1,23 @@ + + + + + +Overview List + + + + + +
All Classes
+
+

Packages

+ +
+

 

+ + diff --git a/documentation/1.3/overview-summary.html b/documentation/1.3/overview-summary.html new file mode 100644 index 0000000..ebb990a --- /dev/null +++ b/documentation/1.3/overview-summary.html @@ -0,0 +1,143 @@ + + + + + +Overview + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+ + + + + + + + + + + + + + + + + + + + +
Packages 
PackageDescription
com.jModule.def 
com.jModule.exec 
com.jModule.util 
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/documentation/1.3/overview-tree.html b/documentation/1.3/overview-tree.html new file mode 100644 index 0000000..167f81e --- /dev/null +++ b/documentation/1.3/overview-tree.html @@ -0,0 +1,153 @@ + + + + + +Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For All Packages

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/documentation/1.3/package-frame.html b/documentation/1.3/package-frame.html new file mode 100644 index 0000000..cf5c746 --- /dev/null +++ b/documentation/1.3/package-frame.html @@ -0,0 +1,20 @@ + + + + + +<Unnamed> + + + + + +

<Unnamed>

+
+

Classes

+ +
+ + diff --git a/documentation/1.3/package-list b/documentation/1.3/package-list new file mode 100644 index 0000000..97651d6 --- /dev/null +++ b/documentation/1.3/package-list @@ -0,0 +1,3 @@ +com.jModule.def +com.jModule.exec +com.jModule.util diff --git a/documentation/1.3/package-summary.html b/documentation/1.3/package-summary.html new file mode 100644 index 0000000..cfc77c9 --- /dev/null +++ b/documentation/1.3/package-summary.html @@ -0,0 +1,131 @@ + + + + + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package <Unnamed>

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/documentation/1.3/package-tree.html b/documentation/1.3/package-tree.html new file mode 100644 index 0000000..f3eff2f --- /dev/null +++ b/documentation/1.3/package-tree.html @@ -0,0 +1,137 @@ + + + + + + Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package <Unnamed>

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/documentation/1.3/package-use.html b/documentation/1.3/package-use.html new file mode 100644 index 0000000..7c0f757 --- /dev/null +++ b/documentation/1.3/package-use.html @@ -0,0 +1,124 @@ + + + + + +Uses of Package + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package

+
+
No usage of
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/documentation/1.3/script.js b/documentation/1.3/script.js new file mode 100644 index 0000000..b346356 --- /dev/null +++ b/documentation/1.3/script.js @@ -0,0 +1,30 @@ +function show(type) +{ + count = 0; + for (var key in methods) { + var row = document.getElementById(key); + if ((methods[key] & type) != 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) +{ + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} diff --git a/documentation/1.3/stylesheet.css b/documentation/1.3/stylesheet.css new file mode 100644 index 0000000..98055b2 --- /dev/null +++ b/documentation/1.3/stylesheet.css @@ -0,0 +1,574 @@ +/* Javadoc style sheet */ +/* +Overall document style +*/ + +@import url('resources/fonts/dejavu.css'); + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4A6782; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.subNavList li{ + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader span{ + margin-right:15px; +} +.indexHeader h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Sans Mono',monospace; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { + width:100%; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; + +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td { + text-align:left; + padding:0px 0px 12px 10px; +} +th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, +td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colLast, th.colOne, .constantsSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + white-space:nowrap; + font-size:13px; +} +td.colLast, th.colLast { + font-size:13px; +} +td.colOne, th.colOne { + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.useSummary td.colFirst, .useSummary th.colFirst, +.overviewSummary td.colOne, .overviewSummary th.colOne, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colOne, .memberSummary th.colOne, +.typeSummary td.colFirst{ + width:25%; + vertical-align:top; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor { + background-color:#FFFFFF; +} +.rowColor { + background-color:#EEEEEF; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} + +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} + +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} + +td.colLast div { + padding-top:0px; +} + + +td.colLast a { + padding-bottom:3px; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, +.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, +.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} + +div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} + +div.contentContainer ul.blockList li.blockList h2{ + padding-bottom:0px; +} diff --git a/src/main/java/com/jModule/def/CommandLogic.java b/src/main/java/com/jModule/def/CommandLogic.java index 3e9608f..a73b372 100644 --- a/src/main/java/com/jModule/def/CommandLogic.java +++ b/src/main/java/com/jModule/def/CommandLogic.java @@ -51,10 +51,10 @@ public String[] getParams() { * public void execute() { * ... * if (onOption('a')) { - * {@literal /}{@literal /} behavior with option 'a' + * {@literal //} behavior with option 'a' * } * if (onOption('b')) { - * {@literal /}{@literal /} behavior with option 'b' + * {@literal //} behavior with option 'b' * } * } *