org.jomc.cli

Class Jomc

java.lang.Object

org.jomc.cli.Jomc

public final class Jomc
extends Object

JOMC command line interface.

Author:

Christian Schulte

Constructor Summary

Constructors

Constructor and Description
Jomc() Creates a new Jomc instance.

Method Summary

Methods

Modifier and Type	Method and Description
static Level	getDefaultLogLevel() Gets the default log level events are logged at.
Level	getLogLevel() Gets the log level of the instance.
PrintWriter	getPrintWriter() Gets the print writer of the instance.
boolean	isLoggable(Level level) Checks if a message at a given level is provided to the listeners of the instance.
int	jomc(String[] args) Processes the given arguments and executes the corresponding command.
static void	main(String[] args) Main entry point.
static int	run(String[] args) Main entry point without exiting the VM.
static void	setDefaultLogLevel(Level value) Sets the default log level events are logged at.
void	setLogLevel(Level value) Sets the log level of the instance.
void	setPrintWriter(PrintWriter value) Sets the print writer of the instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

Jomc

public Jomc()

Creates a new Jomc instance.

Method Detail

getPrintWriter

@IgnoreJRERequirement
public PrintWriter getPrintWriter()

Gets the print writer of the instance.

Returns:

The print writer of the instance.

See Also:

setPrintWriter(java.io.PrintWriter)

setPrintWriter

public void setPrintWriter(PrintWriter value)

Sets the print writer of the instance.

Parameters:

value - The new print writer of the instance or null.

See Also:

getPrintWriter()

getDefaultLogLevel

public static Level getDefaultLogLevel()

Gets the default log level events are logged at.

The default log level is controlled by system property org.jomc.cli.Jomc.defaultLogLevel holding the log level to log events at by default. If that property is not set, the WARNING default is returned.

Returns:

The log level events are logged at by default.

See Also:

getLogLevel(), Level.parse(java.lang.String)

setDefaultLogLevel

public static void setDefaultLogLevel(Level value)

Sets the default log level events are logged at.

Parameters:

value - The new default level events are logged at or null.

See Also:

getDefaultLogLevel()

getLogLevel

public Level getLogLevel()

Gets the log level of the instance.

Returns:

The log level of the instance.

See Also:

getDefaultLogLevel(), setLogLevel(java.util.logging.Level), isLoggable(java.util.logging.Level)

setLogLevel

public void setLogLevel(Level value)

Sets the log level of the instance.

Parameters:

value - The new log level of the instance or null.

See Also:

getLogLevel(), isLoggable(java.util.logging.Level)

isLoggable

public boolean isLoggable(Level level)

Checks if a message at a given level is provided to the listeners of the instance.

Parameters:

level - The level to test.

Returns:

true, if messages at level are provided to the listeners of the instance; false, if messages at level are not provided to the listeners of the instance.

Throws:

NullPointerException - if level is null.

See Also:

getLogLevel(), setLogLevel(java.util.logging.Level)

jomc

public int jomc(String[] args)

Processes the given arguments and executes the corresponding command.

Parameters:

args - Arguments to process.

Returns:

Status code.

See Also:

Command.STATUS_SUCCESS, Command.STATUS_FAILURE

main

public static void main(String[] args)

Main entry point.

Parameters:

args - The application arguments.

run

public static int run(String[] args)

Main entry point without exiting the VM.

Parameters:

args - The application arguments.

Returns:

Status code.

See Also:

Command.STATUS_SUCCESS, Command.STATUS_FAILURE