blob: 972f0c58d9a3e08bcf9104197a2b9b2cd4a06405 (
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
|
package de.lmu.ifi.dbs.elki.logging.progress;
/*
This file is part of ELKI:
Environment for Developing KDD-Applications Supported by Index-Structures
Copyright (C) 2012
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/>.
*/
/**
* Generic Progress logging interface.
*
* @author Erich Schubert
*/
public interface Progress {
/**
* Serialize a description into a String buffer.
*
* @param buf Buffer to serialize to
* @return Buffer the data was serialized to.
*/
public StringBuffer appendToBuffer(StringBuffer buf);
/**
* Test whether a progress is complete (and thus doesn't need to be shown anymore)
*
* @return Whether the progress was completed.
*/
public boolean isComplete();
/**
* Returns a String representation of the progress suitable as a message for
* printing to the command line interface.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString();
}
|
