-
Notifications
You must be signed in to change notification settings - Fork 12
/
ITmfConfigParamDescriptor.java
47 lines (43 loc) · 1.24 KB
/
ITmfConfigParamDescriptor.java
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
/**********************************************************************
* Copyright (c) 2023 Ericsson
*
* All rights reserved. This program and the accompanying materials are
* made available under the terms of the Eclipse Public License 2.0 which
* accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
**********************************************************************/
package org.eclipse.tracecompass.tmf.core.config;
/**
* Interface to implement to describe a configuration parameter.
*
* @since 9.2
* @author Bernd Hufmann
*/
public interface ITmfConfigParamDescriptor {
/**
* The unique name of the key to show to the user
*
* @return the key name
*/
String getKeyName();
/**
* The data type string, e.g. use NUMBER for numbers, or STRING as strings
*
* @return the key name
*/
String getDataType();
/**
* If parameter needs to in the query parameters or not
*
* @return true if required else false
*/
boolean isRequired();
/**
* Optional description that can be shown to the user
*
* @return description of this parameter
*/
String getDescription();
}