Welcome!

Open Source Cloud Authors: Zakia Bouachraoui, Liz McMillan, Elizabeth White, Yeshim Deniz, Pat Romanski

Related Topics: IBM Cloud, Java IoT, Adobe Flex, Open Source Cloud, Eclipse, Machine Learning

IBM Cloud: Article

Reflections on Java Command Line Options

There are many different types of command line options that programs need to recognize

Abstract
There are many different types of command line options that programs need to recognize. Many languages (e.g.: bash and perl) has built-in processing of command line options; Java does not. The Java Command Line Options (JCLO) package performs this task for a variety of option styles. It also uses Java's reflection capability to automatically assign values to variables in a specified class.

Introduction
Even in these days of sophisticated graphical user interfaces, many programs have a wide variety of command line options that help specify their behavior. It is also the case that command line only programs continue to enjoy wide use. It is also the case the command line arguments can become quite complicated, e.g.: -Djava.util.logging.config.file=All.finest -1 --list --this=that Some languages have built-in parsers for command line options; perl and bash are two obvious examples of this. Java has no such parser built in. The JCLO package provides the capability to parse several different command line option formats, and uses Java's reflecion mechanizm to both drive the parsing and assign the values provided by command line options to the variable in a specified class.

Brief overview of command line option formats
UNIX command line options started with a simple "dash and letter" format. "ls -l" is a classic example. If the option specified an additional option, the dash and letter were followed by a space and the additional option. "sort -t separator" is and example. UNIX also allowed the use of numbers, "ls -1", as options. As the number of possible option proliferated, and newer "GNU" style was developed. These have a "double dash/long name" style: "sort --version" for example. When additional options are needed for this style, it is typically provided with a "equals value" style: "gcc --std=c89". Finally, Java has its own style of "single dash/name with dots/equals value" style: "-Djava.util.logging.config.file=logging.props".

Specifying non-Java variable name options
JCLO uses Java reflection to extract variable names as the basis for parsing command line options. Not all styles just described are valid Java variable names and therefore JCLO uses several conventions to allow them specified. Java variables must begin with an alphabetic character or an underscore, numbers are not allowed to start a variable name. Variable names cannot contain dashes, as dashes specify subtraction or negation. They cannot contain dots as dots specify class references or decimal literals. Therefore, JCLO uses the convention of prefixing number options with an underscore (_1). For dashes embedded in options (e.g.: "--font-size=10"), JCLO uses two underscores ("font__size") in the variable name. For the embedded dots, JCLO uses a convention of an underscore followed by a dollar sign "_$".

Brief review of Java reflection
Java, as with other object oriented languages, has the ability to query and modify an object's internal information. One can retrieve a Class's constructors, methods, fields, etc. JCLO uses the getDeclaredFields()" method on a class to find the names it will accept and set the value for. One can either have a single class devoted to command line options or specify a prefix for the variables JCLO's will examine.

From class variables to command line options
First let's look at an example to see how JCLO works in practice. We have the obligatory import:

import edu.mscd.cs.jclo.JCLO;

and then we create a class whose class varibles will become the command line options:

class ExampleArgs
{
    private int a;
    private boolean b;
    private float c;
    private String d;
    private String[] additional;
}

A simple main will be used to illustrate JCLO's operation:

public class Example
{
    public static void main (String args[])
    {
        ExampleArgs ea = new ExampleArgs();
        JCLO jclo = new JCLO (ea);
        jclo.parse (args);
	System.out.println ("a = " + ea.a);
	System.out.println ("b = " + ea.b);
	System.out.println ("c = " + ea.c);
	System.out.println ("d = " + ea.d);
	System.out.println ("additional = " + 
	    java.util.Arrays.toString (ea.additional));
    }
}

First, an object that contains the variables whose values will be assigned by the command line options is created. This object is then used to create a JCLO object. The parse method is then called with the command line options to do the actual work Running this simple program with the following command line options:

java -cp .:JCLO-1.3.4.jar Example -a 5 --b=true --c=9.0 -d Example one two three

produces:

a = 5
b = true
c = 9.0
d = Example
additional = [one, two, three]

Here, each of the class varibles where assigned values from the associated command line option. The additional String array is assigned any options beyond the last dash option. JCLO can also use only certain fields of an object by the programmer specifying a string prefix that those fields begin with.

There are times when command line options have aliases; for example a long and short version. JCLO has the ability to deal with these directly. Adding

String aliases[][] ={{"boolean", "b"}};

and modifying

JCLO jclo = new JCLO (ea, aliases);

to the above example allows for --boolean to set the value for b

:

java -cp .:JCLO-1.3.4.jar Example --boolean
a = 0
b = true
c = 0.0
d = null
additional = null

JCLO also has a simple usage() method that returns a String of possible options and the type of values they require.

Conclusion
JCLO allows one to easily parse command line options and set the values inside a class based on those options. It is very flexible in its parsing, allowing intermixed single- and double-dashed options, along with aliases that allow long and short versions of an option. JCLO is available from http://jclo.sourceforge.net/.

More Stories By Steve Beaty

Steve has an extensive background in both the theoretic and pragmatic aspects of computer science. He wrote compilers at Cray Computer, and both managed a large group of developers and was a software test architect at HP. He has a number of active open-source projects and is a professor of computer science at the Metropolitan State College of Denver.

IoT & Smart Cities Stories
All in Mobile is a place where we continually maximize their impact by fostering understanding, empathy, insights, creativity and joy. They believe that a truly useful and desirable mobile app doesn't need the brightest idea or the most advanced technology. A great product begins with understanding people. It's easy to think that customers will love your app, but can you justify it? They make sure your final app is something that users truly want and need. The only way to do this is by ...
Digital Transformation and Disruption, Amazon Style - What You Can Learn. Chris Kocher is a co-founder of Grey Heron, a management and strategic marketing consulting firm. He has 25+ years in both strategic and hands-on operating experience helping executives and investors build revenues and shareholder value. He has consulted with over 130 companies on innovating with new business models, product strategies and monetization. Chris has held management positions at HP and Symantec in addition to ...
Dynatrace is an application performance management software company with products for the information technology departments and digital business owners of medium and large businesses. Building the Future of Monitoring with Artificial Intelligence. Today we can collect lots and lots of performance data. We build beautiful dashboards and even have fancy query languages to access and transform the data. Still performance data is a secret language only a couple of people understand. The more busine...
DXWorldEXPO LLC announced today that Big Data Federation to Exhibit at the 22nd International CloudEXPO, colocated with DevOpsSUMMIT and DXWorldEXPO, November 12-13, 2018 in New York City. Big Data Federation, Inc. develops and applies artificial intelligence to predict financial and economic events that matter. The company uncovers patterns and precise drivers of performance and outcomes with the aid of machine-learning algorithms, big data, and fundamental analysis. Their products are deployed...
The challenges of aggregating data from consumer-oriented devices, such as wearable technologies and smart thermostats, are fairly well-understood. However, there are a new set of challenges for IoT devices that generate megabytes or gigabytes of data per second. Certainly, the infrastructure will have to change, as those volumes of data will likely overwhelm the available bandwidth for aggregating the data into a central repository. Ochandarena discusses a whole new way to think about your next...
CloudEXPO | DevOpsSUMMIT | DXWorldEXPO are the world's most influential, independent events where Cloud Computing was coined and where technology buyers and vendors meet to experience and discuss the big picture of Digital Transformation and all of the strategies, tactics, and tools they need to realize their goals. Sponsors of DXWorldEXPO | CloudEXPO benefit from unmatched branding, profile building and lead generation opportunities.
Cell networks have the advantage of long-range communications, reaching an estimated 90% of the world. But cell networks such as 2G, 3G and LTE consume lots of power and were designed for connecting people. They are not optimized for low- or battery-powered devices or for IoT applications with infrequently transmitted data. Cell IoT modules that support narrow-band IoT and 4G cell networks will enable cell connectivity, device management, and app enablement for low-power wide-area network IoT. B...
The hierarchical architecture that distributes "compute" within the network specially at the edge can enable new services by harnessing emerging technologies. But Edge-Compute comes at increased cost that needs to be managed and potentially augmented by creative architecture solutions as there will always a catching-up with the capacity demands. Processing power in smartphones has enhanced YoY and there is increasingly spare compute capacity that can be potentially pooled. Uber has successfully ...
SYS-CON Events announced today that CrowdReviews.com has been named “Media Sponsor” of SYS-CON's 22nd International Cloud Expo, which will take place on June 5–7, 2018, at the Javits Center in New York City, NY. CrowdReviews.com is a transparent online platform for determining which products and services are the best based on the opinion of the crowd. The crowd consists of Internet users that have experienced products and services first-hand and have an interest in letting other potential buye...
When talking IoT we often focus on the devices, the sensors, the hardware itself. The new smart appliances, the new smart or self-driving cars (which are amalgamations of many ‘things'). When we are looking at the world of IoT, we should take a step back, look at the big picture. What value are these devices providing. IoT is not about the devices, its about the data consumed and generated. The devices are tools, mechanisms, conduits. This paper discusses the considerations when dealing with the...