From 64e2d7bca93e228e123db78bf2bc037f710a4871 Mon Sep 17 00:00:00 2001 From: akwizgran <akwizgran@users.sourceforge.net> Date: Wed, 12 Oct 2011 17:25:37 +0100 Subject: [PATCH] Refactoring: shorter class names. --- ...hTransportPlugin.java => BatchPlugin.java} | 2 +- ...Callback.java => BatchPluginCallback.java} | 2 +- .../{TransportPlugin.java => Plugin.java} | 2 +- ...sportCallback.java => PluginCallback.java} | 2 +- ...TransportPlugin.java => StreamPlugin.java} | 2 +- ...allback.java => StreamPluginCallback.java} | 2 +- .../net/sf/briar/plugins/AbstractPlugin.java | 4 +- .../plugins/bluetooth/BluetoothPlugin.java | 10 ++-- .../net/sf/briar/plugins/file/FilePlugin.java | 11 ++--- .../plugins/file/RemovableDrivePlugin.java | 4 +- .../plugins/socket/SimpleSocketPlugin.java | 4 +- .../sf/briar/plugins/socket/SocketPlugin.java | 11 ++--- .../bluetooth/BluetoothClientTest.java | 4 +- .../bluetooth/BluetoothServerTest.java | 4 +- .../file/RemovableDrivePluginTest.java | 46 +++++++++---------- .../socket/SimpleSocketPluginTest.java | 4 +- 16 files changed, 56 insertions(+), 58 deletions(-) rename api/net/sf/briar/api/plugins/{BatchTransportPlugin.java => BatchPlugin.java} (92%) rename api/net/sf/briar/api/plugins/{BatchTransportCallback.java => BatchPluginCallback.java} (85%) rename api/net/sf/briar/api/plugins/{TransportPlugin.java => Plugin.java} (95%) rename api/net/sf/briar/api/plugins/{TransportCallback.java => PluginCallback.java} (97%) rename api/net/sf/briar/api/plugins/{StreamTransportPlugin.java => StreamPlugin.java} (88%) rename api/net/sf/briar/api/plugins/{StreamTransportCallback.java => StreamPluginCallback.java} (84%) diff --git a/api/net/sf/briar/api/plugins/BatchTransportPlugin.java b/api/net/sf/briar/api/plugins/BatchPlugin.java similarity index 92% rename from api/net/sf/briar/api/plugins/BatchTransportPlugin.java rename to api/net/sf/briar/api/plugins/BatchPlugin.java index 51348c9633..47f1d5a5de 100644 --- a/api/net/sf/briar/api/plugins/BatchTransportPlugin.java +++ b/api/net/sf/briar/api/plugins/BatchPlugin.java @@ -8,7 +8,7 @@ import net.sf.briar.api.transport.BatchTransportWriter; * An interface for transport plugins that do not support bidirectional, * reliable, ordered, timely delivery of data. */ -public interface BatchTransportPlugin extends TransportPlugin { +public interface BatchPlugin extends Plugin { /** * Attempts to create and return a BatchTransportReader for the given diff --git a/api/net/sf/briar/api/plugins/BatchTransportCallback.java b/api/net/sf/briar/api/plugins/BatchPluginCallback.java similarity index 85% rename from api/net/sf/briar/api/plugins/BatchTransportCallback.java rename to api/net/sf/briar/api/plugins/BatchPluginCallback.java index 525bbb8b28..8c964ed901 100644 --- a/api/net/sf/briar/api/plugins/BatchTransportCallback.java +++ b/api/net/sf/briar/api/plugins/BatchPluginCallback.java @@ -8,7 +8,7 @@ import net.sf.briar.api.transport.BatchTransportWriter; * An interface for receiving readers and writers created by a batch-mode * transport plugin. */ -public interface BatchTransportCallback extends TransportCallback { +public interface BatchPluginCallback extends PluginCallback { void readerCreated(BatchTransportReader r); diff --git a/api/net/sf/briar/api/plugins/TransportPlugin.java b/api/net/sf/briar/api/plugins/Plugin.java similarity index 95% rename from api/net/sf/briar/api/plugins/TransportPlugin.java rename to api/net/sf/briar/api/plugins/Plugin.java index 159553f285..f34fd4b6d4 100644 --- a/api/net/sf/briar/api/plugins/TransportPlugin.java +++ b/api/net/sf/briar/api/plugins/Plugin.java @@ -4,7 +4,7 @@ import java.io.IOException; import net.sf.briar.api.TransportId; -public interface TransportPlugin { +public interface Plugin { /** Returns the plugin's transport identifier. */ TransportId getId(); diff --git a/api/net/sf/briar/api/plugins/TransportCallback.java b/api/net/sf/briar/api/plugins/PluginCallback.java similarity index 97% rename from api/net/sf/briar/api/plugins/TransportCallback.java rename to api/net/sf/briar/api/plugins/PluginCallback.java index b4cac73ceb..88473dc51b 100644 --- a/api/net/sf/briar/api/plugins/TransportCallback.java +++ b/api/net/sf/briar/api/plugins/PluginCallback.java @@ -10,7 +10,7 @@ import net.sf.briar.api.TransportProperties; * An interface through which a transport plugin interacts with the rest of * the application. */ -public interface TransportCallback { +public interface PluginCallback { /** Returns the plugin's configuration. */ TransportConfig getConfig(); diff --git a/api/net/sf/briar/api/plugins/StreamTransportPlugin.java b/api/net/sf/briar/api/plugins/StreamPlugin.java similarity index 88% rename from api/net/sf/briar/api/plugins/StreamTransportPlugin.java rename to api/net/sf/briar/api/plugins/StreamPlugin.java index 5b1a6a7c8c..1cd8893705 100644 --- a/api/net/sf/briar/api/plugins/StreamTransportPlugin.java +++ b/api/net/sf/briar/api/plugins/StreamPlugin.java @@ -7,7 +7,7 @@ import net.sf.briar.api.transport.StreamTransportConnection; * An interface for transport plugins that support bidirectional, reliable, * ordered, timely delivery of data. */ -public interface StreamTransportPlugin extends TransportPlugin { +public interface StreamPlugin extends Plugin { /** * Attempts to create and return a StreamTransportConnection to the given diff --git a/api/net/sf/briar/api/plugins/StreamTransportCallback.java b/api/net/sf/briar/api/plugins/StreamPluginCallback.java similarity index 84% rename from api/net/sf/briar/api/plugins/StreamTransportCallback.java rename to api/net/sf/briar/api/plugins/StreamPluginCallback.java index 7496f40268..74bd4e11a1 100644 --- a/api/net/sf/briar/api/plugins/StreamTransportCallback.java +++ b/api/net/sf/briar/api/plugins/StreamPluginCallback.java @@ -7,7 +7,7 @@ import net.sf.briar.api.transport.StreamTransportConnection; * An interface for receiving connections created by a stream-mode transport * plugin. */ -public interface StreamTransportCallback extends TransportCallback { +public interface StreamPluginCallback extends PluginCallback { void incomingConnectionCreated(StreamTransportConnection c); diff --git a/components/net/sf/briar/plugins/AbstractPlugin.java b/components/net/sf/briar/plugins/AbstractPlugin.java index 1527a67301..1b1c1ff189 100644 --- a/components/net/sf/briar/plugins/AbstractPlugin.java +++ b/components/net/sf/briar/plugins/AbstractPlugin.java @@ -3,9 +3,9 @@ package net.sf.briar.plugins; import java.io.IOException; import java.util.concurrent.Executor; -import net.sf.briar.api.plugins.TransportPlugin; +import net.sf.briar.api.plugins.Plugin; -public abstract class AbstractPlugin implements TransportPlugin { +public abstract class AbstractPlugin implements Plugin { protected final Executor executor; diff --git a/components/net/sf/briar/plugins/bluetooth/BluetoothPlugin.java b/components/net/sf/briar/plugins/bluetooth/BluetoothPlugin.java index 6390b353fe..b906dc073d 100644 --- a/components/net/sf/briar/plugins/bluetooth/BluetoothPlugin.java +++ b/components/net/sf/briar/plugins/bluetooth/BluetoothPlugin.java @@ -21,14 +21,14 @@ import net.sf.briar.api.ContactId; import net.sf.briar.api.TransportConfig; import net.sf.briar.api.TransportId; import net.sf.briar.api.TransportProperties; -import net.sf.briar.api.plugins.StreamTransportCallback; -import net.sf.briar.api.plugins.StreamTransportPlugin; +import net.sf.briar.api.plugins.StreamPluginCallback; +import net.sf.briar.api.plugins.StreamPlugin; import net.sf.briar.api.transport.StreamTransportConnection; import net.sf.briar.plugins.AbstractPlugin; import net.sf.briar.util.OsUtils; import net.sf.briar.util.StringUtils; -class BluetoothPlugin extends AbstractPlugin implements StreamTransportPlugin { +class BluetoothPlugin extends AbstractPlugin implements StreamPlugin { public static final int TRANSPORT_ID = 2; @@ -36,13 +36,13 @@ class BluetoothPlugin extends AbstractPlugin implements StreamTransportPlugin { private static final Logger LOG = Logger.getLogger(BluetoothPlugin.class.getName()); - private final StreamTransportCallback callback; + private final StreamPluginCallback callback; private final long pollingInterval; private LocalDevice localDevice = null; private StreamConnectionNotifier streamConnectionNotifier = null; - BluetoothPlugin(Executor executor, StreamTransportCallback callback, + BluetoothPlugin(Executor executor, StreamPluginCallback callback, long pollingInterval) { super(executor); this.callback = callback; diff --git a/components/net/sf/briar/plugins/file/FilePlugin.java b/components/net/sf/briar/plugins/file/FilePlugin.java index c6ddef1f35..b97d532be3 100644 --- a/components/net/sf/briar/plugins/file/FilePlugin.java +++ b/components/net/sf/briar/plugins/file/FilePlugin.java @@ -10,8 +10,8 @@ import java.util.logging.Level; import java.util.logging.Logger; import net.sf.briar.api.ContactId; -import net.sf.briar.api.plugins.BatchTransportCallback; -import net.sf.briar.api.plugins.BatchTransportPlugin; +import net.sf.briar.api.plugins.BatchPluginCallback; +import net.sf.briar.api.plugins.BatchPlugin; import net.sf.briar.api.transport.BatchTransportReader; import net.sf.briar.api.transport.BatchTransportWriter; import net.sf.briar.api.transport.TransportConstants; @@ -19,19 +19,18 @@ import net.sf.briar.plugins.AbstractPlugin; import org.apache.commons.io.FileSystemUtils; -abstract class FilePlugin extends AbstractPlugin -implements BatchTransportPlugin { +abstract class FilePlugin extends AbstractPlugin implements BatchPlugin { private static final Logger LOG = Logger.getLogger(FilePlugin.class.getName()); - protected final BatchTransportCallback callback; + protected final BatchPluginCallback callback; protected abstract File chooseOutputDirectory(); protected abstract void writerFinished(File f); protected abstract void readerFinished(File f); - protected FilePlugin(Executor executor, BatchTransportCallback callback) { + protected FilePlugin(Executor executor, BatchPluginCallback callback) { super(executor); this.callback = callback; } diff --git a/components/net/sf/briar/plugins/file/RemovableDrivePlugin.java b/components/net/sf/briar/plugins/file/RemovableDrivePlugin.java index 16093fcfb5..7aafe10e7e 100644 --- a/components/net/sf/briar/plugins/file/RemovableDrivePlugin.java +++ b/components/net/sf/briar/plugins/file/RemovableDrivePlugin.java @@ -8,7 +8,7 @@ import java.util.logging.Level; import java.util.logging.Logger; import net.sf.briar.api.TransportId; -import net.sf.briar.api.plugins.BatchTransportCallback; +import net.sf.briar.api.plugins.BatchPluginCallback; class RemovableDrivePlugin extends FilePlugin implements RemovableDriveMonitor.Callback { @@ -22,7 +22,7 @@ implements RemovableDriveMonitor.Callback { private final RemovableDriveFinder finder; private final RemovableDriveMonitor monitor; - RemovableDrivePlugin(Executor executor, BatchTransportCallback callback, + RemovableDrivePlugin(Executor executor, BatchPluginCallback callback, RemovableDriveFinder finder, RemovableDriveMonitor monitor) { super(executor, callback); this.finder = finder; diff --git a/components/net/sf/briar/plugins/socket/SimpleSocketPlugin.java b/components/net/sf/briar/plugins/socket/SimpleSocketPlugin.java index 4a7359ed84..8c57f555de 100644 --- a/components/net/sf/briar/plugins/socket/SimpleSocketPlugin.java +++ b/components/net/sf/briar/plugins/socket/SimpleSocketPlugin.java @@ -10,7 +10,7 @@ import java.util.concurrent.Executor; import net.sf.briar.api.ContactId; import net.sf.briar.api.TransportId; import net.sf.briar.api.TransportProperties; -import net.sf.briar.api.plugins.StreamTransportCallback; +import net.sf.briar.api.plugins.StreamPluginCallback; class SimpleSocketPlugin extends SocketPlugin { @@ -20,7 +20,7 @@ class SimpleSocketPlugin extends SocketPlugin { private final long pollingInterval; - SimpleSocketPlugin(Executor executor, StreamTransportCallback callback, + SimpleSocketPlugin(Executor executor, StreamPluginCallback callback, long pollingInterval) { super(executor, callback); this.pollingInterval = pollingInterval; diff --git a/components/net/sf/briar/plugins/socket/SocketPlugin.java b/components/net/sf/briar/plugins/socket/SocketPlugin.java index 61eab794c6..f90852374a 100644 --- a/components/net/sf/briar/plugins/socket/SocketPlugin.java +++ b/components/net/sf/briar/plugins/socket/SocketPlugin.java @@ -9,18 +9,17 @@ import java.util.logging.Level; import java.util.logging.Logger; import net.sf.briar.api.ContactId; -import net.sf.briar.api.plugins.StreamTransportCallback; -import net.sf.briar.api.plugins.StreamTransportPlugin; +import net.sf.briar.api.plugins.StreamPluginCallback; +import net.sf.briar.api.plugins.StreamPlugin; import net.sf.briar.api.transport.StreamTransportConnection; import net.sf.briar.plugins.AbstractPlugin; -abstract class SocketPlugin extends AbstractPlugin -implements StreamTransportPlugin { +abstract class SocketPlugin extends AbstractPlugin implements StreamPlugin { private static final Logger LOG = Logger.getLogger(SocketPlugin.class.getName()); - protected final StreamTransportCallback callback; + protected final StreamPluginCallback callback; // This field must only be accessed with this's lock held protected ServerSocket socket = null; @@ -35,7 +34,7 @@ implements StreamTransportPlugin { protected abstract SocketAddress getRemoteSocketAddress(ContactId c); protected SocketPlugin(Executor executor, - StreamTransportCallback callback) { + StreamPluginCallback callback) { super(executor); this.callback = callback; } diff --git a/test/net/sf/briar/plugins/bluetooth/BluetoothClientTest.java b/test/net/sf/briar/plugins/bluetooth/BluetoothClientTest.java index fb0c4e0194..fdb352325d 100644 --- a/test/net/sf/briar/plugins/bluetooth/BluetoothClientTest.java +++ b/test/net/sf/briar/plugins/bluetooth/BluetoothClientTest.java @@ -8,7 +8,7 @@ import java.util.Scanner; import net.sf.briar.api.ContactId; import net.sf.briar.api.TransportConfig; import net.sf.briar.api.TransportProperties; -import net.sf.briar.api.plugins.StreamTransportCallback; +import net.sf.briar.api.plugins.StreamPluginCallback; import net.sf.briar.api.transport.StreamTransportConnection; import net.sf.briar.plugins.ImmediateExecutor; @@ -60,7 +60,7 @@ public class BluetoothClientTest { plugin.stop(); } - private static class ClientCallback implements StreamTransportCallback { + private static class ClientCallback implements StreamPluginCallback { private TransportConfig config = new TransportConfig(); private TransportProperties local = new TransportProperties(); diff --git a/test/net/sf/briar/plugins/bluetooth/BluetoothServerTest.java b/test/net/sf/briar/plugins/bluetooth/BluetoothServerTest.java index b1339026ba..ec9a54bb7a 100644 --- a/test/net/sf/briar/plugins/bluetooth/BluetoothServerTest.java +++ b/test/net/sf/briar/plugins/bluetooth/BluetoothServerTest.java @@ -9,7 +9,7 @@ import java.util.Scanner; import net.sf.briar.api.ContactId; import net.sf.briar.api.TransportConfig; import net.sf.briar.api.TransportProperties; -import net.sf.briar.api.plugins.StreamTransportCallback; +import net.sf.briar.api.plugins.StreamPluginCallback; import net.sf.briar.api.transport.StreamTransportConnection; import net.sf.briar.plugins.ImmediateExecutor; @@ -40,7 +40,7 @@ public class BluetoothServerTest { plugin.stop(); } - private static class ServerCallback implements StreamTransportCallback { + private static class ServerCallback implements StreamPluginCallback { private TransportConfig config = new TransportConfig(); private TransportProperties local = new TransportProperties(); diff --git a/test/net/sf/briar/plugins/file/RemovableDrivePluginTest.java b/test/net/sf/briar/plugins/file/RemovableDrivePluginTest.java index fb97975515..d64f20db89 100644 --- a/test/net/sf/briar/plugins/file/RemovableDrivePluginTest.java +++ b/test/net/sf/briar/plugins/file/RemovableDrivePluginTest.java @@ -11,7 +11,7 @@ import java.util.concurrent.Executor; import junit.framework.TestCase; import net.sf.briar.TestUtils; import net.sf.briar.api.ContactId; -import net.sf.briar.api.plugins.BatchTransportCallback; +import net.sf.briar.api.plugins.BatchPluginCallback; import net.sf.briar.api.transport.BatchTransportWriter; import net.sf.briar.api.transport.TransportConstants; import net.sf.briar.plugins.ImmediateExecutor; @@ -37,8 +37,8 @@ public class RemovableDrivePluginTest extends TestCase { public void testGetId() { Mockery context = new Mockery(); final Executor executor = context.mock(Executor.class); - final BatchTransportCallback callback = - context.mock(BatchTransportCallback.class); + final BatchPluginCallback callback = + context.mock(BatchPluginCallback.class); final RemovableDriveFinder finder = context.mock(RemovableDriveFinder.class); final RemovableDriveMonitor monitor = @@ -59,8 +59,8 @@ public class RemovableDrivePluginTest extends TestCase { Mockery context = new Mockery(); final Executor executor = context.mock(Executor.class); - final BatchTransportCallback callback = - context.mock(BatchTransportCallback.class); + final BatchPluginCallback callback = + context.mock(BatchPluginCallback.class); final RemovableDriveFinder finder = context.mock(RemovableDriveFinder.class); final RemovableDriveMonitor monitor = @@ -91,8 +91,8 @@ public class RemovableDrivePluginTest extends TestCase { Mockery context = new Mockery(); final Executor executor = context.mock(Executor.class); - final BatchTransportCallback callback = - context.mock(BatchTransportCallback.class); + final BatchPluginCallback callback = + context.mock(BatchPluginCallback.class); final RemovableDriveFinder finder = context.mock(RemovableDriveFinder.class); final RemovableDriveMonitor monitor = @@ -128,8 +128,8 @@ public class RemovableDrivePluginTest extends TestCase { Mockery context = new Mockery(); final Executor executor = context.mock(Executor.class); - final BatchTransportCallback callback = - context.mock(BatchTransportCallback.class); + final BatchPluginCallback callback = + context.mock(BatchPluginCallback.class); final RemovableDriveFinder finder = context.mock(RemovableDriveFinder.class); final RemovableDriveMonitor monitor = @@ -167,8 +167,8 @@ public class RemovableDrivePluginTest extends TestCase { Mockery context = new Mockery(); final Executor executor = context.mock(Executor.class); - final BatchTransportCallback callback = - context.mock(BatchTransportCallback.class); + final BatchPluginCallback callback = + context.mock(BatchPluginCallback.class); final RemovableDriveFinder finder = context.mock(RemovableDriveFinder.class); final RemovableDriveMonitor monitor = @@ -206,8 +206,8 @@ public class RemovableDrivePluginTest extends TestCase { Mockery context = new Mockery(); final Executor executor = context.mock(Executor.class); - final BatchTransportCallback callback = - context.mock(BatchTransportCallback.class); + final BatchPluginCallback callback = + context.mock(BatchPluginCallback.class); final RemovableDriveFinder finder = context.mock(RemovableDriveFinder.class); final RemovableDriveMonitor monitor = @@ -248,8 +248,8 @@ public class RemovableDrivePluginTest extends TestCase { Mockery context = new Mockery(); final Executor executor = context.mock(Executor.class); - final BatchTransportCallback callback = - context.mock(BatchTransportCallback.class); + final BatchPluginCallback callback = + context.mock(BatchPluginCallback.class); final RemovableDriveFinder finder = context.mock(RemovableDriveFinder.class); final RemovableDriveMonitor monitor = @@ -294,8 +294,8 @@ public class RemovableDrivePluginTest extends TestCase { public void testEmptyDriveIsIgnored() throws Exception { Mockery context = new Mockery(); final Executor executor = context.mock(Executor.class); - final BatchTransportCallback callback = - context.mock(BatchTransportCallback.class); + final BatchPluginCallback callback = + context.mock(BatchPluginCallback.class); final RemovableDriveFinder finder = context.mock(RemovableDriveFinder.class); final RemovableDriveMonitor monitor = @@ -318,8 +318,8 @@ public class RemovableDrivePluginTest extends TestCase { public void testFilenames() { Mockery context = new Mockery(); final Executor executor = context.mock(Executor.class); - final BatchTransportCallback callback = - context.mock(BatchTransportCallback.class); + final BatchPluginCallback callback = + context.mock(BatchPluginCallback.class); final RemovableDriveFinder finder = context.mock(RemovableDriveFinder.class); final RemovableDriveMonitor monitor = @@ -341,8 +341,8 @@ public class RemovableDrivePluginTest extends TestCase { @Test public void testSmallFileIsIgnored() throws Exception { Mockery context = new Mockery(); - final BatchTransportCallback callback = - context.mock(BatchTransportCallback.class); + final BatchPluginCallback callback = + context.mock(BatchPluginCallback.class); final RemovableDriveFinder finder = context.mock(RemovableDriveFinder.class); final RemovableDriveMonitor monitor = @@ -370,8 +370,8 @@ public class RemovableDrivePluginTest extends TestCase { @Test public void testReaderIsCreated() throws Exception { Mockery context = new Mockery(); - final BatchTransportCallback callback = - context.mock(BatchTransportCallback.class); + final BatchPluginCallback callback = + context.mock(BatchPluginCallback.class); final RemovableDriveFinder finder = context.mock(RemovableDriveFinder.class); final RemovableDriveMonitor monitor = diff --git a/test/net/sf/briar/plugins/socket/SimpleSocketPluginTest.java b/test/net/sf/briar/plugins/socket/SimpleSocketPluginTest.java index 1e96dcc9fa..fd41e7f9cb 100644 --- a/test/net/sf/briar/plugins/socket/SimpleSocketPluginTest.java +++ b/test/net/sf/briar/plugins/socket/SimpleSocketPluginTest.java @@ -14,7 +14,7 @@ import junit.framework.TestCase; import net.sf.briar.api.ContactId; import net.sf.briar.api.TransportConfig; import net.sf.briar.api.TransportProperties; -import net.sf.briar.api.plugins.StreamTransportCallback; +import net.sf.briar.api.plugins.StreamPluginCallback; import net.sf.briar.api.transport.StreamTransportConnection; import net.sf.briar.plugins.ImmediateExecutor; @@ -99,7 +99,7 @@ public class SimpleSocketPluginTest extends TestCase { plugin.stop(); } - private static class StreamCallback implements StreamTransportCallback { + private static class StreamCallback implements StreamPluginCallback { private TransportConfig config = new TransportConfig(); private TransportProperties local = new TransportProperties(); -- GitLab