Welcome!

Eclipse Authors: Pat Romanski, Elizabeth White, Liz McMillan, David H Deans, JP Morgenthal

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.

@ThingsExpo Stories
SYS-CON Events announced today that Interface Corporation will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Interface Corporation is a company developing, manufacturing and marketing high quality and wide variety of industrial computers and interface modules such as PCIs and PCI express. For more information, visit http://www.i...
SYS-CON Events announced today that mruby Forum will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. mruby is the lightweight implementation of the Ruby language. We introduce mruby and the mruby IoT framework that enhances development productivity. For more information, visit http://forum.mruby.org/.
In his session at @ThingsExpo, Greg Gorman is the Director, IoT Developer Ecosystem, Watson IoT, will provide a short tutorial on Node-RED, a Node.js-based programming tool for wiring together hardware devices, APIs and online services in new and interesting ways. It provides a browser-based editor that makes it easy to wire together flows using a wide range of nodes in the palette that can be deployed to its runtime in a single-click. There is a large library of contributed nodes that help so...
What is the best strategy for selecting the right offshore company for your business? In his session at 21st Cloud Expo, Alan Winters, U.S. Head of Business Development at MobiDev, will discuss the things to look for - positive and negative - in evaluating your options. He will also discuss how to maximize productivity with your offshore developers. Before you start your search, clearly understand your business needs and how that impacts software choices.
SYS-CON Events announced today that Mobile Create USA will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Mobile Create USA Inc. is an MVNO-based business model that uses portable communication devices and cellular-based infrastructure in the development, sales, operation and mobile communications systems incorporating GPS capabi...
While some developers care passionately about how data centers and clouds are architected, for most, it is only the end result that matters. To the majority of companies, technology exists to solve a business problem, and only delivers value when it is solving that problem. 2017 brings the mainstream adoption of containers for production workloads. In his session at 21st Cloud Expo, Ben McCormack, VP of Operations at Evernote, will discuss how data centers of the future will be managed, how th...
There is huge complexity in implementing a successful digital business that requires efficient on-premise and cloud back-end infrastructure, IT and Internet of Things (IoT) data, analytics, Machine Learning, Artificial Intelligence (AI) and Digital Applications. In the data center alone, there are physical and virtual infrastructures, multiple operating systems, multiple applications and new and emerging business and technological paradigms such as cloud computing and XaaS. And then there are pe...
SYS-CON Events announced today that MIRAI Inc. will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. MIRAI Inc. are IT consultants from the public sector whose mission is to solve social issues by technology and innovation and to create a meaningful future for people.
SYS-CON Events announced today that Keisoku Research Consultant Co. will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Keisoku Research Consultant, Co. offers research and consulting in a wide range of civil engineering-related fields from information construction to preservation of cultural properties. For more information, vi...
SYS-CON Events announced today that Massive Networks, that helps your business operate seamlessly with fast, reliable, and secure internet and network solutions, has been named "Exhibitor" of SYS-CON's 21st International Cloud Expo ®, which will take place on Oct 31 - Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. As a premier telecommunications provider, Massive Networks is headquartered out of Louisville, Colorado. With years of experience under their belt, their team of...
SYS-CON Events announced today that Enroute Lab will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Enroute Lab is an industrial design, research and development company of unmanned robotic vehicle system. For more information, please visit http://elab.co.jp/.
SYS-CON Events announced today that Ryobi Systems will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Ryobi Systems Co., Ltd., as an information service company, specialized in business support for local governments and medical industry. We are challenging to achive the precision farming with AI. For more information, visit http:...
Real IoT production deployments running at scale are collecting sensor data from hundreds / thousands / millions of devices. The goal is to take business-critical actions on the real-time data and find insights from stored datasets. In his session at @ThingsExpo, John Walicki, Watson IoT Developer Advocate at IBM Cloud, will provide a fast-paced developer journey that follows the IoT sensor data from generation, to edge gateway, to edge analytics, to encryption, to the IBM Bluemix cloud, to Wa...
SYS-CON Events announced today that Fusic will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Fusic Co. provides mocks as virtual IoT devices. You can customize mocks, and get any amount of data at any time in your test. For more information, visit https://fusic.co.jp/english/.
SYS-CON Events announced today that B2Cloud will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. B2Cloud specializes in IoT devices for preventive and predictive maintenance in any kind of equipment retrieving data like Energy consumption, working time, temperature, humidity, pressure, etc.
SYS-CON Events announced today that NetApp has been named “Bronze Sponsor” of SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. NetApp is the data authority for hybrid cloud. NetApp provides a full range of hybrid cloud data services that simplify management of applications and data across cloud and on-premises environments to accelerate digital transformation. Together with their partners, NetApp em...
Elon Musk is among the notable industry figures who worries about the power of AI to destroy rather than help society. Mark Zuckerberg, on the other hand, embraces all that is going on. AI is most powerful when deployed across the vast networks being built for Internets of Things in the manufacturing, transportation and logistics, retail, healthcare, government and other sectors. Is AI transforming IoT for the good or the bad? Do we need to worry about its potential destructive power? Or will we...
SYS-CON Events announced today that SIGMA Corporation will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. uLaser flow inspection device from the Japanese top share to Global Standard! Then, make the best use of data to flip to next page. For more information, visit http://www.sigma-k.co.jp/en/.
Agile has finally jumped the technology shark, expanding outside the software world. Enterprises are now increasingly adopting Agile practices across their organizations in order to successfully navigate the disruptive waters that threaten to drown them. In our quest for establishing change as a core competency in our organizations, this business-centric notion of Agile is an essential component of Agile Digital Transformation. In the years since the publication of the Agile Manifesto, the conn...
SYS-CON Events announced today that Nihon Micron will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Nihon Micron Co., Ltd. strives for technological innovation to establish high-density, high-precision processing technology for providing printed circuit board and metal mount RFID tags used for communication devices. For more inf...