blob: 20cdc6c7239e3f117e8bc129f6e509b661ecf397 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
|
package de.lmu.ifi.dbs.elki.utilities.optionhandling;
/*
This file is part of ELKI:
Environment for Developing KDD-Applications Supported by Index-Structures
Copyright (C) 2015
Ludwig-Maximilians-Universität München
Lehr- und Forschungseinheit für Datenbanksysteme
ELKI Development Team
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* An OptionID is used by option handlers as a unique identifier for specific
* options. There is no option possible without a specific OptionID defined
* within this class.
*
* @author Elke Achtert
*/
public final class OptionID {
/**
* Option name
*/
private String name;
/**
* The description of the OptionID.
*/
private String description;
/**
* Constructor.
*
* @param name the name of the option
* @param description the description of the option
*/
public OptionID(final String name, final String description) {
super();
this.name = name;
this.description = description;
}
/**
* Returns the description of this OptionID.
*
* @return the description of this OptionID
*/
public String getDescription() {
return description;
}
/**
* Gets or creates the OptionID for the given class and given name. The
* OptionID usually is named as the classes name (lowercase) as name-prefix
* and the given name as suffix of the complete name, separated by a dot. For
* example, the parameter {@code epsilon} for the class
* {@link de.lmu.ifi.dbs.elki.algorithm.clustering.DBSCAN} will be named
* {@code dbscan.epsilon}.
*
* @param name the name
* @param description the description is also set if the named OptionID does
* exist already
* @return the OptionID for the given name
*/
public static OptionID getOrCreateOptionID(final String name, final String description) {
return new OptionID(name, description);
}
/**
* Returns the name of this OptionID.
*
* @return the name
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
return getName();
}
/**
* Get the option name.
*
* @return Option name
*/
public String getName() {
return name;
}
}
|
