I2P Address: [http://git.idk.i2p]

Skip to content
Snippets Groups Projects
Unverified Commit af5456b8 authored by zzz's avatar zzz
Browse files

add javadocs for banlist return values

parent 2c955e30
No related branches found
No related tags found
No related merge requests found
...@@ -115,33 +115,56 @@ public class Banlist { ...@@ -115,33 +115,56 @@ public class Banlist {
return Collections.unmodifiableMap(_entries); return Collections.unmodifiableMap(_entries);
} }
/**
* @return true if it WAS previously on the list
*/
public boolean banlistRouter(Hash peer) { public boolean banlistRouter(Hash peer) {
return banlistRouter(peer, null); return banlistRouter(peer, null);
} }
/**
* @return true if it WAS previously on the list
*/
public boolean banlistRouter(Hash peer, String reason) { return banlistRouter(peer, reason, null); } public boolean banlistRouter(Hash peer, String reason) { return banlistRouter(peer, reason, null); }
/** ick have to put the reasonCode in the front to avoid ambiguity */ /**
* @return true if it WAS previously on the list
*/
public boolean banlistRouter(String reasonCode, Hash peer, String reason) { public boolean banlistRouter(String reasonCode, Hash peer, String reason) {
return banlistRouter(peer, reason, reasonCode, null, false); return banlistRouter(peer, reason, reasonCode, null, false);
} }
/**
* @return true if it WAS previously on the list
*/
public boolean banlistRouter(Hash peer, String reason, String transport) { public boolean banlistRouter(Hash peer, String reason, String transport) {
return banlistRouter(peer, reason, transport, false); return banlistRouter(peer, reason, transport, false);
} }
/**
* @return true if it WAS previously on the list
*/
public boolean banlistRouterForever(Hash peer, String reason) { public boolean banlistRouterForever(Hash peer, String reason) {
return banlistRouter(peer, reason, null, true); return banlistRouter(peer, reason, null, true);
} }
/**
* @return true if it WAS previously on the list
*/
public boolean banlistRouterForever(Hash peer, String reason, String reasonCode) { public boolean banlistRouterForever(Hash peer, String reason, String reasonCode) {
return banlistRouter(peer, reason, reasonCode, null, true); return banlistRouter(peer, reason, reasonCode, null, true);
} }
/**
* @return true if it WAS previously on the list
*/
public boolean banlistRouter(Hash peer, String reason, String transport, boolean forever) { public boolean banlistRouter(Hash peer, String reason, String transport, boolean forever) {
return banlistRouter(peer, reason, null, transport, forever); return banlistRouter(peer, reason, null, transport, forever);
} }
/**
* @return true if it WAS previously on the list
*/
private boolean banlistRouter(Hash peer, String reason, String reasonCode, String transport, boolean forever) { private boolean banlistRouter(Hash peer, String reason, String reasonCode, String transport, boolean forever) {
long expireOn; long expireOn;
if (forever) { if (forever) {
...@@ -164,6 +187,7 @@ public class Banlist { ...@@ -164,6 +187,7 @@ public class Banlist {
* @param reasonCode may be null * @param reasonCode may be null
* @param expireOn absolute time, not a duration * @param expireOn absolute time, not a duration
* @param transport may be null * @param transport may be null
* @return true if it WAS previously on the list
* @since 0.9.18 * @since 0.9.18
*/ */
public boolean banlistRouter(Hash peer, String reason, String reasonCode, String transport, long expireOn) { public boolean banlistRouter(Hash peer, String reason, String reasonCode, String transport, long expireOn) {
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment