| 1 | /*
|
|---|
| 2 | * This program is free software; you can redistribute it and/or modify
|
|---|
| 3 | * it under the terms of the GNU General Public License as published by
|
|---|
| 4 | * the Free Software Foundation; either version 2 of the License, or
|
|---|
| 5 | * (at your option) any later version.
|
|---|
| 6 | *
|
|---|
| 7 | * This program is distributed in the hope that it will be useful,
|
|---|
| 8 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|---|
| 9 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|---|
| 10 | * GNU General Public License for more details.
|
|---|
| 11 | *
|
|---|
| 12 | * You should have received a copy of the GNU General Public License
|
|---|
| 13 | * along with this program; if not, write to the Free Software
|
|---|
| 14 | * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
|
|---|
| 15 | */
|
|---|
| 16 |
|
|---|
| 17 | /*
|
|---|
| 18 | * Option.java
|
|---|
| 19 | * Copyright (C) 1999 Eibe Frank
|
|---|
| 20 | *
|
|---|
| 21 | */
|
|---|
| 22 |
|
|---|
| 23 | package weka.core;
|
|---|
| 24 |
|
|---|
| 25 | /**
|
|---|
| 26 | * Class to store information about an option. <p>
|
|---|
| 27 | *
|
|---|
| 28 | * Typical usage: <p>
|
|---|
| 29 | *
|
|---|
| 30 | * <code>Option myOption = new Option("Uses extended mode.", "E", 0, "-E")); </code><p>
|
|---|
| 31 | *
|
|---|
| 32 | * @author Eibe Frank ([email protected])
|
|---|
| 33 | * @version $Revision: 8815 $
|
|---|
| 34 | */
|
|---|
| 35 | public class Option {
|
|---|
| 36 |
|
|---|
| 37 | /** What does this option do? */
|
|---|
| 38 | private String m_Description;
|
|---|
| 39 |
|
|---|
| 40 | /** The synopsis. */
|
|---|
| 41 | private String m_Synopsis;
|
|---|
| 42 |
|
|---|
| 43 | /** What's the option's name? */
|
|---|
| 44 | private String m_Name;
|
|---|
| 45 |
|
|---|
| 46 | /** How many arguments does it take? */
|
|---|
| 47 | private int m_NumArguments;
|
|---|
| 48 |
|
|---|
| 49 | /**
|
|---|
| 50 | * Creates new option with the given parameters.
|
|---|
| 51 | *
|
|---|
| 52 | * @String description the option's description
|
|---|
| 53 | * @String name the option's name
|
|---|
| 54 | * @String numArguments the number of arguments
|
|---|
| 55 | */
|
|---|
| 56 | public Option(String description, String name,
|
|---|
| 57 | int numArguments, String synopsis) {
|
|---|
| 58 |
|
|---|
| 59 | m_Description = description;
|
|---|
| 60 | m_Name = name;
|
|---|
| 61 | m_NumArguments = numArguments;
|
|---|
| 62 | m_Synopsis = synopsis;
|
|---|
| 63 | }
|
|---|
| 64 |
|
|---|
| 65 | /**
|
|---|
| 66 | * Returns the option's description.
|
|---|
| 67 | *
|
|---|
| 68 | * @return the option's description
|
|---|
| 69 | */
|
|---|
| 70 | public String description() {
|
|---|
| 71 |
|
|---|
| 72 | return m_Description;
|
|---|
| 73 | }
|
|---|
| 74 |
|
|---|
| 75 | /**
|
|---|
| 76 | * Returns the option's name.
|
|---|
| 77 | *
|
|---|
| 78 | * @return the option's name
|
|---|
| 79 | */
|
|---|
| 80 | public String name() {
|
|---|
| 81 |
|
|---|
| 82 | return m_Name;
|
|---|
| 83 | }
|
|---|
| 84 |
|
|---|
| 85 | /**
|
|---|
| 86 | * Returns the option's number of arguments.
|
|---|
| 87 | *
|
|---|
| 88 | * @return the option's number of arguments
|
|---|
| 89 | */
|
|---|
| 90 | public int numArguments() {
|
|---|
| 91 |
|
|---|
| 92 | return m_NumArguments;
|
|---|
| 93 | }
|
|---|
| 94 |
|
|---|
| 95 | /**
|
|---|
| 96 | * Returns the option's synopsis.
|
|---|
| 97 | *
|
|---|
| 98 | * @return the option's synopsis
|
|---|
| 99 | */
|
|---|
| 100 | public String synopsis() {
|
|---|
| 101 |
|
|---|
| 102 | return m_Synopsis;
|
|---|
| 103 | }
|
|---|
| 104 | }
|
|---|
| 105 |
|
|---|
