Package ipsk.util.optionparser

Class OptionParser

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<Option>, java.util.Collection<Option>, java.util.List<Option>, java.util.RandomAccess
    public class OptionParser
extends java.util.Vector<Option>
    Parses command line parameter tokens. Splits the given parameter tokens into options and parameters. An option starts with an '-' character. Currently only short options ( option name has only one char) are supported. The parameter token '--' is interpreted as end of th option section.
    Author:
    K.Jaensch, klausj@phonetik.uni-muenchen.de
    See Also:
    Serialized Form

    • Field Summary

      • Fields inherited from class java.util.AbstractList

        modCount

      • Fields inherited from class java.util.Vector

        capacityIncrement, elementCount, elementData

    • Constructor Summary

      Constructors 
      Constructor Description
      OptionParser()
      Create option parser.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addOption​(Option o)
      Add a syntactically allowed option.
      void addOption​(java.lang.String opt)
      Add an syntactically allowed option by name.
      void addOption​(java.lang.String opt, java.lang.String value)
      Add an syntactically allowed option with parameter by name.
      Option getOption​(java.lang.String opt)
      Get option by name.
      Option[] getOptions()
      Get all set options.
      java.lang.String[] getParams()
      Returns command line parameters.
      boolean isOptionSet​(java.lang.String opt)
      Returns true if the option is set on the command line.
      static void main​(java.lang.String[] args)  
      void parse​(java.lang.String[] args)
      Parse a command line.
      void parse​(java.util.List<java.lang.String> args)
      Parse a command line.
      void removeOption​(Option o)
      Remove an allowed option.
      void setParams​(java.lang.String[] strings)
      Set command line parameters.

      • Methods inherited from interface java.util.Collection

        parallelStream, stream

      • Methods inherited from interface java.util.List

      • Methods inherited from class java.lang.Object

        finalize, getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from class java.util.Vector

        add, add, addAll, addAll, addElement, capacity, clear, clone, contains, containsAll, copyInto, elementAt, elements, ensureCapacity, equals, firstElement, forEach, get, hashCode, indexOf, indexOf, insertElementAt, isEmpty, iterator, lastElement, lastIndexOf, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeAllElements, removeElement, removeElementAt, removeIf, removeRange, replaceAll, retainAll, set, setElementAt, setSize, size, sort, spliterator, subList, toArray, toArray, toString, trimToSize

    • Constructor Detail

      • OptionParser

        public OptionParser()
        Create option parser.

    • Method Detail

      • addOption

        public void addOption​(Option o)
        Add a syntactically allowed option.
        Parameters:
        o - option

      • removeOption

        public void removeOption​(Option o)
        Remove an allowed option.
        Parameters:
        o - option

      • addOption

        public void addOption​(java.lang.String opt)
        Add an syntactically allowed option by name.
        Parameters:
        opt -

      • addOption

        public void addOption​(java.lang.String opt,
                      java.lang.String value)
        Add an syntactically allowed option with parameter by name.
        Parameters:
        opt - option
        value - default value

      • parse

        public void parse​(java.util.List<java.lang.String> args)
           throws OptionParserException
        Parse a command line.
        Parameters:
        args - as string list
        Throws:
        OptionParserException - if an syntax error occurs

      • parse

        public void parse​(java.lang.String[] args)
           throws OptionParserException
        Parse a command line.
        Parameters:
        args - command line as string array
        Throws:
        OptionParserException - if an syntax error occurs

      • isOptionSet

        public boolean isOptionSet​(java.lang.String opt)
        Returns true if the option is set on the command line.
        Parameters:
        opt - name of the option
        Returns:
        true if set

      • getOption

        public Option getOption​(java.lang.String opt)
        Get option by name.
        Parameters:
        opt - name of option
        Returns:
        option

      • getParams

        public java.lang.String[] getParams()
        Returns command line parameters.
        Returns:
        command line parameters

      • setParams

        public void setParams​(java.lang.String[] strings)
        Set command line parameters.
        Parameters:
        strings - command line parameters

      • getOptions

        public Option[] getOptions()
        Get all set options.
        Returns:
        options

      • main

        public static void main​(java.lang.String[] args)