net.proteusframework.core

Class CommandUtil

java.lang.Object

net.proteusframework.core.CommandUtil

public class CommandUtil
extends Object

CommandLine utility.

Author:

Russ Tennant (russ@i2rd.com)

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SPRING_PROPERTIES Default Spring Properties Location.

Method Summary

Modifier and Type	Method and Description
static String	ask(String prompt, Object... args) Ask a question to the console user.
static void	clearConsole() Clear the console.
static void	copyResourceToStream(Class<?> resourceRoot, String resource, OutputStream os) Copy the resource to the specified stream.
static void	copyResourceToWriter(Class<?> resourceRoot, String resource, Writer writer) Copy the resource to the specified writer.
static void	copyResourceToWriter(Class<?> resourceRoot, String resource, Writer writer, Map<String,String> replacement) Copy the resource to the specified writer.
static List<File>	getBrowserExecutable() Get a web browser executable file.
static List<File>	getFiles(FileFilter fileFilter) Get a list of files that match the filter.
static InetAddress	getInterface() Get the interface.
static int	getPort() Get the port.
static PropertyResolver	getSpringProperties() Get spring properties.
static void	setupConsoleLogger() Setup a console logger.
static void	setupSystemProperties(String defaultContext, String propMatch) Setup system properties.
static void	shutdownConsoleLogger() Shutdown console logger.
static Process	startBrowser(InetAddress ia, int port, File startWebBrowser) Start a web browser.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SPRING_PROPERTIES

public static final String DEFAULT_SPRING_PROPERTIES

Default Spring Properties Location.

See Also:

Constant Field Values

Method Detail

ask

public static String ask(String prompt,
                         Object... args)
                  throws IOException

Ask a question to the console user.

Parameters:

prompt - the prompt.

args - the arguments for the prompt (printf style).

Returns:

the answer or null if end of stream.

Throws:

IOException - if an IO error occurs.

clearConsole

public static void clearConsole()

Clear the console.

copyResourceToStream

public static void copyResourceToStream(Class<?> resourceRoot,
                                        String resource,
                                        OutputStream os)
                                 throws IOException

Copy the resource to the specified stream.

Parameters:

resourceRoot - resource root.

resource - the resource.

os - the output stream.

Throws:

IOException - if an error occurs.

copyResourceToWriter

public static void copyResourceToWriter(Class<?> resourceRoot,
                                        String resource,
                                        Writer writer)
                                 throws IOException

Copy the resource to the specified writer.

Parameters:

resourceRoot - resource root.

resource - the resource.

writer - the writer.

Throws:

IOException - if an error occurs.

copyResourceToWriter

public static void copyResourceToWriter(Class<?> resourceRoot,
                                        String resource,
                                        Writer writer,
                                        @Nullable
                                        Map<String,String> replacement)
                                 throws IOException

Copy the resource to the specified writer.

Parameters:

resourceRoot - resource root.

resource - the resource.

writer - the writer.

replacement - optional replacement mapping.

Throws:

IOException - if an error occurs.

getBrowserExecutable

public static List<File> getBrowserExecutable()

Get a web browser executable file.

Returns:

the file or null.

getFiles

public static List<File> getFiles(FileFilter fileFilter)

Get a list of files that match the filter.

Parameters:

fileFilter - the filter.

Returns:

the files.

getInterface

public static InetAddress getInterface()
                                throws Exception

Get the interface.

Returns:

the interface.

Throws:

Exception - if an error occurs.

getPort

public static int getPort()
                   throws IOException

Get the port.

Returns:

the port.

Throws:

IOException - if an error occurs.

getSpringProperties

public static PropertyResolver getSpringProperties()

Get spring properties.

Returns:

spring properties as a property source..

setupConsoleLogger

public static void setupConsoleLogger()

Setup a console logger.

setupSystemProperties

public static void setupSystemProperties(String defaultContext,
                                         String propMatch)
                                  throws IOException

Setup system properties.

Parameters:

defaultContext - the default context.

propMatch - property to match as default.

Throws:

IOException - if an error occurs

shutdownConsoleLogger

public static void shutdownConsoleLogger()

Shutdown console logger.

startBrowser

@Nullable
public static Process startBrowser(InetAddress ia,
                                             int port,
                                             File startWebBrowser)
                                      throws Exception

Start a web browser.

Parameters:

ia - address.

port - port.

startWebBrowser - attempt to start the specified web browser.

Returns:

if a browser was started the thread is returned or null.

Throws:

Exception - if an error occurs.