com.asakusafw.windgate.cli

Class CommandLineUtil

java.lang.Object

com.asakusafw.windgate.cli.CommandLineUtil

public final class CommandLineUtil
extends Object

Utilities for command line interfaces.

Since:

0.2.2

Version:

0.4.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOG_CONTEXT_PREFIX Prefix of system properties used for log context.
static String	SCHEME_CLASSPATH The scheme name of Java class path.

Method Summary

Modifier and Type	Method and Description
static ClassLoader	buildPluginLoader(ClassLoader parent, List<File> files) Creates a class loader for loading plug-ins.
static Properties	loadProperties(URI path, ClassLoader loader) Loads properties from the specified URI.
static ParameterList	parseArguments(String arguments) Parses the specified arguments string and returns key-value pairs.
static List<File>	parseFileList(String fileListOrNull) Parses a string of file list separated by the platform dependent path separator.
static void	prepareLogContext() Prepares log context.
static void	prepareRuntimeContext() Prepares runtime context.
static String	toName(URI uri) Returns the name of URI for hint.
static URI	toUri(String path) Converts the path to the related URI.

Methods inherited from class java.lang.Object

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

Field Detail

LOG_CONTEXT_PREFIX

public static final String LOG_CONTEXT_PREFIX

Prefix of system properties used for log context.

See Also:

Constant Field Values

SCHEME_CLASSPATH

public static final String SCHEME_CLASSPATH

The scheme name of Java class path.

See Also:

Constant Field Values

Method Detail

prepareRuntimeContext

public static void prepareRuntimeContext()

Prepares runtime context.

prepareLogContext

public static void prepareLogContext()

Prepares log context. If current system properties contain keys with a special prefix (described in LOG_CONTEXT_PREFIX), then this method will put each key-value pairs into log MDC.

toName

public static String toName(URI uri)

Returns the name of URI for hint.

Parameters:

uri - the target URI

Returns:

the name

Throws:

IllegalArgumentException - if some parameters were null

toUri

public static URI toUri(String path)
                 throws URISyntaxException

Converts the path to the related URI.

Parameters:

path - target path

Returns:

the related URI

Throws:

URISyntaxException - if failed to convert the path

IllegalArgumentException - if some parameters were null

loadProperties

public static Properties loadProperties(URI path,
                                        ClassLoader loader)
                                 throws IOException

Loads properties from the specified URI. URI can have following forms.

• no scheme - relative path from the current working directory (local file system)
• "classpath" scheme - absolute path on loader's class path
• other scheme - as a URL

Parameters:

path - path to the target properties

loader - the class loader for the scheme "classpath", or null to use the system class loader

Returns:

the loaded properties

Throws:

IOException - if failed to load the properties

IllegalArgumentException - if any parameter is null

parseFileList

public static List<File> parseFileList(String fileListOrNull)

Parses a string of file list separated by the platform dependent path separator.

Parameters:

fileListOrNull - target string, or null

Returns:

the represented file list, or an empty list if not specified

buildPluginLoader

public static ClassLoader buildPluginLoader(ClassLoader parent,
                                            List<File> files)

Creates a class loader for loading plug-ins.

Parameters:

parent - parent class loader, or null to use the system class loader

files - plug-in class paths (*.jar file or class path directory)

Returns:

the created class loader

Throws:

IllegalArgumentException - if some parameters were null

parseArguments

public static ParameterList parseArguments(String arguments)

Parses the specified arguments string and returns key-value pairs. The arguments string is represented as following syntax with ArgumentList as the goal symbol. The each result pair will have Value_key as its key, and Value_value as value.

ArgumentList:
    ArgumentList "," Argument
    Argument
    ","
    (Empty)

Argument:
    Value_key "=" Value_value

Value:
    Character*

Character:
    any character except ",", "=", "\\"
    "\" any character

Parameters:

arguments - the arguments represented in a string, or null as empty arguments

Returns:

the parsed key-value pairs