weka.core
Class Option

java.lang.Object
  weka.core.Option

public class Option

extends java.lang.Object

Class to store information about an option.

Typical usage:

Option myOption = new Option("Uses extended mode.", "E", 0, "-E"));

Version:

$Revision: 1.5 $

Author:

Eibe Frank (eibe@cs.waikato.ac.nz)

Field Summary

private java.lang.String	m_Description What does this option do?
private java.lang.String	m_Name What's the option's name?
private int	m_NumArguments How many arguments does it take?
private java.lang.String	m_Synopsis The synopsis.

Constructor Summary

Option(java.lang.String description, java.lang.String name, int numArguments, java.lang.String synopsis)
Creates new option with the given parameters.

Method Summary

java.lang.String	description() Returns the option's description.
java.lang.String	name() Returns the option's name.
int	numArguments() Returns the option's number of arguments.
java.lang.String	synopsis() Returns the option's synopsis.

Methods inherited from class java.lang.Object

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

Field Detail

m_Description

private java.lang.String m_Description

What does this option do?

m_Synopsis

private java.lang.String m_Synopsis

The synopsis.

m_Name

private java.lang.String m_Name

What's the option's name?

m_NumArguments

private int m_NumArguments

How many arguments does it take?

Constructor Detail

Option

public Option(java.lang.String description,
              java.lang.String name,
              int numArguments,
              java.lang.String synopsis)

Creates new option with the given parameters.

Parameters:

description - the option's description

name - the option's name

numArguments - the number of arguments

Method Detail

description

public java.lang.String description()

Returns the option's description.

Returns:

the option's description

name

public java.lang.String name()

Returns the option's name.

Returns:

the option's name

numArguments

public int numArguments()

Returns the option's number of arguments.

Returns:

the option's number of arguments

synopsis

public java.lang.String synopsis()

Returns the option's synopsis.

Returns:

the option's synopsis