version 3.0, updated mvn plugins, syntax changes.

Author: stalep

aesh/pom.xml

@@ -24,14 +24,14 @@
    <parent>
         <groupId>org.aesh</groupId>
         <artifactId>aesh-all</artifactId>
-        <version>3.0-dev</version>
+        <version>3.0</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>
 
    <groupId>org.aesh</groupId>
    <artifactId>aesh</artifactId>
    <packaging>jar</packaging>
-   <version>3.0-dev</version>
+   <version>3.0</version>
    <name>Æsh</name>
    <description>Æsh (Another Extendable SHell)</description>
    <scm>
@@ -105,39 +105,6 @@
                </execution>
             </executions>
          </plugin>
-	 <plugin>
-           <groupId>org.apache.maven.plugins</groupId>
-           <artifactId>maven-source-plugin</artifactId>
-           <executions>
-             <execution>
-               <id>attach-sources</id>
-               <phase>verify</phase>
-               <goals>
-                 <goal>jar-no-fork</goal>
-               </goals>
-             </execution>
-           </executions>
-         </plugin>
-         <plugin>
-           <groupId>org.apache.maven.plugins</groupId>
-           <artifactId>maven-checkstyle-plugin</artifactId>
-          <executions>
-             <execution>
-               <id>validate</id>
-               <phase>validate</phase>           
-               <configuration>
-                 <configLocation>config/checkstyle/checkstyle.xml</configLocation>                   
-                 <consoleOutput>true</consoleOutput>
-                 <failsOnError>true</failsOnError>
-                 <useFile/>
-                 <includeTestSourceDirectory>true</includeTestSourceDirectory>
-               </configuration>
-               <goals>
-                 <goal>check</goal>
-               </goals>
-             </execution>
-           </executions>
-         </plugin>
        </plugins>
    </build>
 

aesh/src/main/java/org/aesh/AeshConsoleRunner.java

@@ -1,7 +1,7 @@
 /*
  * JBoss, Home of Professional Open Source
  * Copyright 2014 Red Hat Inc. and/or its affiliates and other contributors
- * as indicated by the @authors tag. All rights reserved.
+ * as indicated by the @authors tag
  * See the copyright.txt in the distribution for a
  * full listing of individual contributors.
  *
@@ -19,6 +19,8 @@
  */
 package org.aesh;
 
+import java.io.IOException;
+
 import org.aesh.command.Command;
 import org.aesh.command.CommandDefinition;
 import org.aesh.command.CommandResult;
@@ -28,16 +30,14 @@
 import org.aesh.command.registry.CommandRegistryException;
 import org.aesh.command.settings.Settings;
 import org.aesh.command.settings.SettingsBuilder;
-import org.aesh.readline.Prompt;
 import org.aesh.console.ReadlineConsole;
+import org.aesh.readline.Prompt;
 import org.aesh.terminal.Connection;
 
-import java.io.IOException;
-
 /**
  * Use the AeshConsoleRunner when you want to easily create an interactive CLI application.
  *
- * @author <a href="mailto:stalep@gmail.com">Ståle Pedersen</a>
+ * @author Aesh team
  */
 public class AeshConsoleRunner {
     private AeshCommandRegistryBuilder<CommandInvocation> registryBuilder;
@@ -54,7 +54,7 @@ public static AeshConsoleRunner builder() {
     }
 
     public AeshConsoleRunner commands(Class<? extends Command>... commands) {
-        if(commands != null) {
+        if (commands != null) {
             ensureRegistryBuilderInitialized();
             try {
                 registryBuilder.commands(commands);
@@ -66,7 +66,7 @@ public AeshConsoleRunner commands(Class<? extends Command>... commands) {
     }
 
     public AeshConsoleRunner command(Class<? extends Command> command) {
-        if(command != null) {
+        if (command != null) {
             ensureRegistryBuilderInitialized();
             try {
                 registryBuilder.command(command);
@@ -78,24 +78,24 @@ public AeshConsoleRunner command(Class<? extends Command> command) {
     }
 
     public AeshConsoleRunner commandRegistryBuilder(AeshCommandRegistryBuilder<CommandInvocation> commandRegistryBuilder) {
-        if(registryBuilder != null) {
+        if (registryBuilder != null) {
             throw new RuntimeException("Cannot set CommandRegistryBuilder after it has been initialized. " +
                     "CommandRegistryBuilder must be set before adding any commands.");
         }
-        if(commandRegistryBuilder != null) {
+        if (commandRegistryBuilder != null) {
             this.registryBuilder = commandRegistryBuilder;
         }
         return this;
     }
 
     private void ensureRegistryBuilderInitialized() {
-        if(registryBuilder == null) {
+        if (registryBuilder == null) {
             registryBuilder = AeshCommandRegistryBuilder.builder();
         }
     }
 
     public AeshConsoleRunner settings(Settings settings) {
-        if(settings != null)
+        if (settings != null)
             this.settings = settings;
         return this;
     }
@@ -106,17 +106,17 @@ public AeshConsoleRunner connection(Connection connection) {
     }
 
     public AeshConsoleRunner prompt(String prompt) {
-        if(prompt != null)
+        if (prompt != null)
             this.prompt = new Prompt(prompt);
-        if(console != null && console.running())
+        if (console != null && console.running())
             console.setPrompt(this.prompt);
         return this;
     }
 
     public AeshConsoleRunner prompt(Prompt prompt) {
-        if(prompt != null)
+        if (prompt != null)
             this.prompt = prompt;
-        if(console != null && console.running())
+        if (console != null && console.running())
             console.setPrompt(this.prompt);
         return this;
     }
@@ -132,29 +132,28 @@ public AeshConsoleRunner addExitCommand() {
     }
 
     public void start() {
-        if(console == null) {
+        if (console == null) {
             init();
-            if(prompt != null)
+            if (prompt != null)
                 console.setPrompt(prompt);
             try {
                 console.start();
-            }
-            catch (IOException e) {
-                throw new RuntimeException("Exception while starting the console: "+e.getMessage());
+            } catch (IOException e) {
+                throw new RuntimeException("Exception while starting the console: " + e.getMessage());
             }
         }
     }
 
     public void stop() {
-        if(console != null && console.running())
+        if (console != null && console.running())
             console.stop();
     }
 
     @SuppressWarnings("unchecked")
     private void init() {
         // Build the command registry from the builder
         CommandRegistry<CommandInvocation> builtRegistry = null;
-        if(registryBuilder != null) {
+        if (registryBuilder != null) {
             try {
                 builtRegistry = registryBuilder.create();
             } catch (Exception e) {
@@ -163,58 +162,58 @@ private void init() {
         }
 
         // Check if both builder and settings.commandRegistry have commands
-        if(builtRegistry != null && !builtRegistry.getAllCommandNames().isEmpty() &&
+        if (builtRegistry != null && !builtRegistry.getAllCommandNames().isEmpty() &&
                 settings != null && settings.commandRegistry() != null &&
                 !settings.commandRegistry().getAllCommandNames().isEmpty()) {
-            throw new RuntimeException("Cannot define commands in both AeshConsoleRunner (via command() or commandRegistryBuilder()) " +
-                    "and Settings.commandRegistry(). Please use only one method to specify commands.");
+            throw new RuntimeException(
+                    "Cannot define commands in both AeshConsoleRunner (via command() or commandRegistryBuilder()) " +
+                            "and Settings.commandRegistry(). Please use only one method to specify commands.");
         }
 
         // Determine which registry to use
         CommandRegistry<CommandInvocation> finalRegistry = null;
-        if(builtRegistry != null && !builtRegistry.getAllCommandNames().isEmpty()) {
+        if (builtRegistry != null && !builtRegistry.getAllCommandNames().isEmpty()) {
             finalRegistry = builtRegistry;
-        } else if(settings != null && settings.commandRegistry() != null &&
+        } else if (settings != null && settings.commandRegistry() != null &&
                 !settings.commandRegistry().getAllCommandNames().isEmpty()) {
             finalRegistry = settings.commandRegistry();
         }
 
         // Validate that we have at least one command
-        if(finalRegistry == null || finalRegistry.getAllCommandNames().isEmpty()) {
+        if (finalRegistry == null || finalRegistry.getAllCommandNames().isEmpty()) {
             throw new RuntimeException("No commands added, nothing to run");
         }
 
         try {
-            if(settings == null) {
+            if (settings == null) {
                 settings = SettingsBuilder.builder()
-                                   .commandRegistry(finalRegistry)
-                                   .enableAlias(false)
-                                   .enableExport(false)
-                                   .enableMan(false)
-                                   .persistHistory(false)
-                                   .connection(connection)
-                                   .build();
+                        .commandRegistry(finalRegistry)
+                        .enableAlias(false)
+                        .enableExport(false)
+                        .enableMan(false)
+                        .persistHistory(false)
+                        .connection(connection)
+                        .build();
             }
             // User added their own settings object, but we need to add or replace the registry
-            else if(settings.commandRegistry() == null ||
+            else if (settings.commandRegistry() == null ||
                     settings.commandRegistry().getAllCommandNames().isEmpty()) {
                 SettingsBuilder settingsBuilder = new SettingsBuilder(settings)
-                                                   .commandRegistry(finalRegistry);
+                        .commandRegistry(finalRegistry);
 
-                if(connection != null)
+                if (connection != null)
                     settingsBuilder.connection(connection);
 
                 settings = settingsBuilder.build();
             }
 
             console = new ReadlineConsole(settings);
-        }
-        catch (Exception e) {
+        } catch (Exception e) {
             throw new RuntimeException("Error when initializing console: " + e.getMessage(), e);
         }
     }
 
-    @CommandDefinition(name = "exit", description = "exit the program", aliases = {"quit"})
+    @CommandDefinition(name = "exit", description = "exit the program", aliases = { "quit" })
     public static class ExitCommand implements Command {
         @Override
         public CommandResult execute(CommandInvocation commandInvocation) {

aesh/src/main/java/org/aesh/AeshRuntimeRunner.java

@@ -1,7 +1,7 @@
 /*
  * JBoss, Home of Professional Open Source
  * Copyright 2014 Red Hat Inc. and/or its affiliates and other contributors
- * as indicated by the @authors tag. All rights reserved.
+ * as indicated by the @authors tag
  * See the copyright.txt in the distribution for a
  * full listing of individual contributors.
  *
@@ -35,15 +35,14 @@
 import org.aesh.command.validator.CommandValidatorException;
 import org.aesh.command.validator.OptionValidatorException;
 import org.aesh.console.ShellImpl;
-import org.aesh.terminal.tty.TerminalConnection;
 import org.aesh.terminal.Connection;
+import org.aesh.terminal.tty.TerminalConnection;
 
 /**
- * @author <a href="mailto:stalep@gmail.com">Ståle Pedersen</a>
+ * @author Aesh team
  */
 public class AeshRuntimeRunner {
 
-
     private CommandRuntime runtime;
 
     AeshCommandRegistryBuilder registryBuilder = AeshCommandRegistryBuilder.builder();
@@ -61,7 +60,7 @@ public static AeshRuntimeRunner builder() {
     public AeshRuntimeRunner command(Class<? extends Command> command) {
         try {
             registryBuilder.command(command);
-        } catch (CommandRegistryException  e) {
+        } catch (CommandRegistryException e) {
             throw new RuntimeException("Exception while building command: " + e.getMessage());
         }
         return this;
@@ -70,7 +69,7 @@ public AeshRuntimeRunner command(Class<? extends Command> command) {
     public AeshRuntimeRunner command(Command commandInstance) {
         try {
             registryBuilder.command(commandInstance);
-        } catch (CommandRegistryException  e) {
+        } catch (CommandRegistryException e) {
             throw new RuntimeException("Exception while building command: " + e.getMessage());
         }
         return this;
@@ -100,16 +99,15 @@ public CommandResult execute() {
             throw new RuntimeException("Command needs to be added");
         try {
 
-
             if (runtime == null) {
-                   AeshCommandRuntimeBuilder runtimeBuilder = AeshCommandRuntimeBuilder.builder();
-                   if(interactive) {
-                       connection = new TerminalConnection();
-                       connection.openNonBlocking();
-                       runtimeBuilder.shell(new ShellImpl(connection));
-                   }
+                AeshCommandRuntimeBuilder runtimeBuilder = AeshCommandRuntimeBuilder.builder();
+                if (interactive) {
+                    connection = new TerminalConnection();
+                    connection.openNonBlocking();
+                    runtimeBuilder.shell(new ShellImpl(connection));
+                }
 
-                   runtime = runtimeBuilder.commandRegistry(commandRegistry).build();
+                runtime = runtimeBuilder.commandRegistry(commandRegistry).build();
 
             }
 
@@ -146,7 +144,7 @@ else if (commandNames.size() > 1)
             } catch (InterruptedException | IOException e) {
                 System.err.println(e.getMessage());
             }
-            if(connection != null)
+            if (connection != null)
                 connection.close();
 
             return result;