Misc. stuff: javadoc, UNUSED...

shendaras
This commit is contained in:
shendaras
2004-07-02 02:54:04 +00:00
committed by zzz
parent 8a7e787f42
commit 8c9f58b939
18 changed files with 81 additions and 50 deletions

View File

@ -90,7 +90,7 @@ class ClientEngine {
/** our actual heartbeat pumper - this drives the test */ /** our actual heartbeat pumper - this drives the test */
private class ClientRunner implements Runnable { private class ClientRunner implements Runnable {
/* (non-Javadoc) /**
* @see java.lang.Runnable#run() * @see java.lang.Runnable#run()
*/ */
public void run() { public void run() {

View File

@ -157,7 +157,7 @@ public class Heartbeat {
} }
/** disconnect from the network */ /** disconnect from the network */
private void disconnect() { private void disconnect() { /* UNUSED */
_adapter.disconnect(); _adapter.disconnect();
} }

View File

@ -46,7 +46,7 @@ class I2PAdapter {
/** how do we talk to the router */ /** how do we talk to the router */
private I2PSession _session; private I2PSession _session;
/** object that receives our i2cp notifications from the session and tells us */ /** object that receives our i2cp notifications from the session and tells us */
private I2PListener _i2pListener; private I2PListener _i2pListener; /* UNUSED */
/** /**
* This config property tells us where the private destination data for our * This config property tells us where the private destination data for our
@ -578,14 +578,14 @@ class I2PAdapter {
* @see net.i2p.client.I2PSessionListener#errorOccurred(net.i2p.client.I2PSession, java.lang.String, java.lang.Throwable) * @see net.i2p.client.I2PSessionListener#errorOccurred(net.i2p.client.I2PSession, java.lang.String, java.lang.Throwable)
*/ */
public void errorOccurred(I2PSession session, String message, Throwable error) { public void errorOccurred(I2PSession session, String message, Throwable error) {
if (_log.shouldLog(Log.ERROR)) _log.error("Error occurred", error); if (_log.shouldLog(Log.ERROR)) _log.error("Error occurred: " + message, error);
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see net.i2p.client.I2PSessionListener#reportAbuse(net.i2p.client.I2PSession, int) * @see net.i2p.client.I2PSessionListener#reportAbuse(net.i2p.client.I2PSession, int)
*/ */
public void reportAbuse(I2PSession session, int severity) { public void reportAbuse(I2PSession session, int severity) {
if (_log.shouldLog(Log.ERROR)) _log.error("Abuse reported"); if (_log.shouldLog(Log.ERROR)) _log.error("Abuse reported with severity " + String.valueOf(severity));
} }
/* (non-Javadoc) /* (non-Javadoc)

View File

@ -103,6 +103,11 @@ public class PeerData {
* @return when the test began * @return when the test began
*/ */
public long getSessionStart() { return _sessionStart; } public long getSessionStart() { return _sessionStart; }
/**
* sets when the test began
* @param when when it began
*/
public void setSessionStart(long when) { _sessionStart = when; } public void setSessionStart(long when) { _sessionStart = when; }
/** /**
@ -332,6 +337,11 @@ public class PeerData {
* @return the time the ping was sent * @return the time the ping was sent
*/ */
public long getPingSent() { return _pingSent; } public long getPingSent() { return _pingSent; }
/**
* sets when we sent this ping
* @param when when we sent the ping
*/
public void setPingSent(long when) { _pingSent = when; } public void setPingSent(long when) { _pingSent = when; }
/** /**

View File

@ -21,7 +21,7 @@ class HeartbeatControlPane extends JPanel {
private HeartbeatMonitorGUI _gui; private HeartbeatMonitorGUI _gui;
private JTabbedPane _configPane; private JTabbedPane _configPane;
private final static Color WHITE = new Color(255, 255, 255); private final static Color WHITE = new Color(255, 255, 255);
private final static Color LIGHT_BLUE = new Color(180, 180, 255); private final static Color LIGHT_BLUE = new Color(180, 180, 255); /* UNUSED */
private final static Color BLACK = new Color(0, 0, 0); private final static Color BLACK = new Color(0, 0, 0);
private Color _background = WHITE; private Color _background = WHITE;
private Color _foreground = BLACK; private Color _foreground = BLACK;

View File

@ -88,7 +88,9 @@ public class HeartbeatMonitor implements PeerPlotStateFetcher.FetchStateReceptor
_gui.stateUpdated(); _gui.stateUpdated();
} }
/** store the config defining what peer tests we are monitoring (and how to render) */ /**
* store the config defining what peer tests we are monitoring (and how to render)
*/
void storeConfig() {} void storeConfig() {}
/** /**
@ -103,6 +105,10 @@ public class HeartbeatMonitor implements PeerPlotStateFetcher.FetchStateReceptor
new HeartbeatMonitor().runMonitor(); new HeartbeatMonitor().runMonitor();
} }
/**
* Called when the config is updated
* @param config the updated config
*/
public void configUpdated(PeerPlotConfig config) { public void configUpdated(PeerPlotConfig config) {
_log.debug("Config updated, revamping the gui"); _log.debug("Config updated, revamping the gui");
_gui.stateUpdated(); _gui.stateUpdated();

View File

@ -19,7 +19,7 @@ import net.i2p.heartbeat.PeerData;
import net.i2p.util.Log; import net.i2p.util.Log;
class JFreeChartAdapter { class JFreeChartAdapter {
private final static Log _log = new Log(JFreeChartAdapter.class); private final static Log _log = new Log(JFreeChartAdapter.class); /* UNUSED */
private final static Color WHITE = new Color(255, 255, 255); private final static Color WHITE = new Color(255, 255, 255);
ChartPanel createPanel(HeartbeatMonitorState state) { ChartPanel createPanel(HeartbeatMonitorState state) {
@ -45,7 +45,7 @@ class JFreeChartAdapter {
updateLines(plot, state); updateLines(plot, state);
} }
private long getFirst(HeartbeatMonitorState state) { private long getFirst(HeartbeatMonitorState state) { /* UNUSED */
long first = -1; long first = -1;
for (int i = 0; i < state.getTestCount(); i++) { for (int i = 0; i < state.getTestCount(); i++) {
List dataPoints = state.getTest(i).getCurrentData().getDataPoints(); List dataPoints = state.getTest(i).getCurrentData().getDataPoints();
@ -116,6 +116,7 @@ class JFreeChartAdapter {
} }
/** /**
* @param col the collection of xy series to add to
* @param config preferences for how to display this test * @param config preferences for how to display this test
* @param lineName minimal name of the test (e.g. "jxHa.32KB.60s") * @param lineName minimal name of the test (e.g. "jxHa.32KB.60s")
* @param data List of PeerData.EventDataPoint describing all of the events in the test * @param data List of PeerData.EventDataPoint describing all of the events in the test
@ -144,6 +145,7 @@ class JFreeChartAdapter {
/** /**
* Add a data series for each average that we're configured to render * Add a data series for each average that we're configured to render
* *
* @param col the collection of xy series to add to
* @param config preferences for how to display this test * @param config preferences for how to display this test
* @param lineName minimal name of the test (e.g. "jxHa.32KB.60s") * @param lineName minimal name of the test (e.g. "jxHa.32KB.60s")
* @param data List of PeerData.EventDataPoint describing all of the events in the test * @param data List of PeerData.EventDataPoint describing all of the events in the test

View File

@ -14,14 +14,21 @@ import net.i2p.util.Log;
* *
*/ */
class JFreeChartHeartbeatPlotPane extends HeartbeatPlotPane { class JFreeChartHeartbeatPlotPane extends HeartbeatPlotPane {
private final static Log _log = new Log(JFreeChartHeartbeatPlotPane.class); private final static Log _log = new Log(JFreeChartHeartbeatPlotPane.class); /* UNUSED */
private ChartPanel _panel; private ChartPanel _panel;
private JFreeChartAdapter _adapter; private JFreeChartAdapter _adapter;
/**
* Creates a JFreeChart plot pane for the given gui
* @param gui the heartbeat monitor gui
*/
public JFreeChartHeartbeatPlotPane(HeartbeatMonitorGUI gui) { public JFreeChartHeartbeatPlotPane(HeartbeatMonitorGUI gui) {
super(gui); super(gui);
} }
/**
* Called when the state is updated
*/
public void stateUpdated() { public void stateUpdated() {
if (_panel == null) { if (_panel == null) {
remove(0); // remove the dummy remove(0); // remove the dummy

View File

@ -18,7 +18,7 @@ import net.i2p.util.Log;
* Configure how we want to render a particular clientConfig in the GUI * Configure how we want to render a particular clientConfig in the GUI
*/ */
class PeerPlotConfig { class PeerPlotConfig {
private final static Log _log = new Log(PeerPlotConfig.class); private final static Log _log = new Log(PeerPlotConfig.class); /* UNUSED */
/** where can we find the current state/data (either as a filename or a URL)? */ /** where can we find the current state/data (either as a filename or a URL)? */
private String _location; private String _location;
/** what test are we defining the plot data for? */ /** what test are we defining the plot data for? */
@ -170,8 +170,8 @@ class PeerPlotConfig {
Destination peer = getClientConfig().getPeer(); Destination peer = getClientConfig().getPeer();
if (peer == null) if (peer == null)
return "????"; return "????";
else
return peer.calculateHash().toBase64().substring(0, 4); return peer.calculateHash().toBase64().substring(0, 4);
} }
/** /**
@ -196,8 +196,8 @@ class PeerPlotConfig {
int bytes = getClientConfig().getSendSize(); int bytes = getClientConfig().getSendSize();
if (bytes < 1024) if (bytes < 1024)
return bytes + "b"; return bytes + "b";
else
return bytes/1024 + "kb"; return bytes/1024 + "kb";
} }
/** /**

View File

@ -243,6 +243,7 @@ class PeerPlotConfigPane extends JPanel implements PeerPlotConfig.UpdateListener
_minutes = minutes; _minutes = minutes;
_button = button; _button = button;
} }
/* (non-Javadoc) /* (non-Javadoc)
* @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent) * @see java.awt.event.ActionListener#actionPerformed(java.awt.event.ActionEvent)
*/ */

View File

@ -326,7 +326,7 @@ class PeerPlotStateFetcher {
} }
} }
private void fakeRun() { private void fakeRun() { /* UNUSED */
try { try {
Destination peer = new Destination(); Destination peer = new Destination();
Destination us = new Destination(); Destination us = new Destination();

View File

@ -94,8 +94,8 @@ class StaticPeerData extends PeerData {
Integer i = (Integer)_averageSendTimes.get(new Integer(period)); Integer i = (Integer)_averageSendTimes.get(new Integer(period));
if (i == null) if (i == null)
return -1; return -1;
else
return i.doubleValue(); return i.doubleValue();
} }
@ -109,8 +109,8 @@ class StaticPeerData extends PeerData {
Integer i = (Integer)_averageReceiveTimes.get(new Integer(period)); Integer i = (Integer)_averageReceiveTimes.get(new Integer(period));
if (i == null) if (i == null)
return -1; return -1;
else
return i.doubleValue(); return i.doubleValue();
} }
/** /**
@ -123,8 +123,8 @@ class StaticPeerData extends PeerData {
Integer i = (Integer)_lostMessages.get(new Integer(period)); Integer i = (Integer)_lostMessages.get(new Integer(period));
if (i == null) if (i == null)
return -1; return -1;
else
return i.doubleValue(); return i.doubleValue();
} }
/* (non-Javadoc) /* (non-Javadoc)

View File

@ -57,14 +57,14 @@ public class HTTPListener extends Thread {
* @return Whether this is the first proxy use, no doubt. * @return Whether this is the first proxy use, no doubt.
*/ */
public boolean firstProxyUse() { public boolean firstProxyUse() {
// FIXME: check a config option here if (true) return false; // FIXME: check a config option here
if (true) return false;
if (proxyUsed) { if (proxyUsed) {
return false; return false;
} else {
proxyUsed = true;
return true;
} }
proxyUsed = true;
return true;
} }
/** /**

View File

@ -12,7 +12,7 @@ import net.i2p.util.Log;
*/ */
public class ErrorHandler { public class ErrorHandler {
private static final Log _log = new Log(ErrorHandler.class); private static final Log _log = new Log(ErrorHandler.class); /* UNUSED */
/* package private */ErrorHandler() { /* package private */ErrorHandler() {

View File

@ -13,7 +13,7 @@ import net.i2p.util.Log;
*/ */
public class LocalHandler { public class LocalHandler {
private static final Log _log = new Log(LocalHandler.class); private static final Log _log = new Log(LocalHandler.class); /* UNUSED */
/* package private */LocalHandler() { /* package private */LocalHandler() {
} }

View File

@ -18,7 +18,7 @@ import net.i2p.util.Log;
*/ */
public class ProxyHandler extends EepHandler { public class ProxyHandler extends EepHandler {
private static final Log _log = new Log(ErrorHandler.class); private static final Log _log = new Log(ErrorHandler.class); /* UNUSED */
private static I2PAppContext _context = new I2PAppContext(); private static I2PAppContext _context = new I2PAppContext();
/* package private */ProxyHandler(ErrorHandler eh) { /* package private */ProxyHandler(ErrorHandler eh) {

View File

@ -12,7 +12,7 @@ import net.i2p.util.Log;
*/ */
public class RootHandler { public class RootHandler {
private static final Log _log = new Log(RootHandler.class); private static final Log _log = new Log(RootHandler.class); /* UNUSED */
private RootHandler() { private RootHandler() {
errorHandler = new ErrorHandler(); errorHandler = new ErrorHandler();
@ -60,26 +60,24 @@ public class RootHandler {
url = url.substring(7); url = url.substring(7);
pos = url.indexOf("/"); pos = url.indexOf("/");
String host; String host;
String rest;
if (pos == -1) { if (pos == -1) {
errorHandler.handle(req, httpl, out, "No host end in URL"); errorHandler.handle(req, httpl, out, "No host end in URL");
return; return;
}
host = url.substring(0, pos);
url = url.substring(pos);
if ("i2p".equals(host) || "i2p.i2p".equals(host)) {
// normal request; go on below...
} else if (host.endsWith(".i2p")) {
// "old" service request, send a redirect...
out.write(("HTTP/1.1 302 Moved\r\nLocation: " + "http://i2p.i2p/" + host + url + "\r\n\r\n").getBytes("ISO-8859-1"));
return;
} else { } else {
host = url.substring(0, pos); // this is for proxying to the real web
url = url.substring(pos); proxyHandler.handle(req, httpl, out /*, true */);
if ("i2p".equals(host) || "i2p.i2p".equals(host)) { return;
// normal request; go on below...
} else if (host.endsWith(".i2p")) {
// "old" service request, send a redirect...
out
.write(("HTTP/1.1 302 Moved\r\nLocation: " + "http://i2p.i2p/" + host + url + "\r\n\r\n")
.getBytes("ISO-8859-1"));
return;
} else {
// this is for proxying to the real web
proxyHandler.handle(req, httpl, out /*, true */);
return;
}
} }
} }
if (url.equals("/")) { // main page if (url.equals("/")) { // main page

View File

@ -17,6 +17,9 @@ class BufferLogger implements Logging {
private ByteArrayOutputStream _baos; private ByteArrayOutputStream _baos;
private boolean _ignore; private boolean _ignore;
/**
* Constructs a buffered logger.
*/
public BufferLogger() { public BufferLogger() {
_baos = new ByteArrayOutputStream(512); _baos = new ByteArrayOutputStream(512);
_ignore = false; _ignore = false;
@ -24,11 +27,15 @@ class BufferLogger implements Logging {
private final static String EMPTY = ""; private final static String EMPTY = "";
/**
* Retrieves the buffer
* @return the buffer
*/
public String getBuffer() { public String getBuffer() {
if (_ignore) if (_ignore)
return EMPTY; return EMPTY;
else
return new String(_baos.toByteArray()); return new String(_baos.toByteArray());
} }
/** /**