Skip to content

Commit 4578204

Browse files
committed
Better names for the SocketOwner subclasses.
1 parent fd4da9b commit 4578204

3 files changed

Lines changed: 10 additions & 9 deletions

File tree

atplug-runtime/src/main/java/com/diffplug/atplug/SocketOwner.kt

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ abstract class SocketOwner<T>(val socketClass: Class<T>) {
2121
PlugDescriptor(plug!!::class.java.name, socketClass.name, metadata(plug)).toJson()
2222

2323
/**
24-
* Instantiates the given plug. Already implemented by the default implementations [Id] and
25-
* [Complex]. If you implement this yourself, make sure that you call [PlugRegistry.register] in
26-
* your constructor.
24+
* Instantiates the given plug. Already implemented by the default implementations [SingletonById]
25+
* and [EphemeralByDescriptor]. If you implement this yourself, make sure that you call
26+
* [PlugRegistry.register] in your constructor.
2727
*/
2828
protected abstract fun instantiatePlug(plugDescriptor: PlugDescriptor): T
2929

@@ -39,7 +39,8 @@ abstract class SocketOwner<T>(val socketClass: Class<T>) {
3939

4040
protected abstract fun remove(plugDescriptor: PlugDescriptor)
4141

42-
abstract class Complex<T, ParsedDescriptor>(socketClass: Class<T>) : SocketOwner<T>(socketClass) {
42+
abstract class EphemeralByDescriptor<T, ParsedDescriptor>(socketClass: Class<T>) :
43+
SocketOwner<T>(socketClass) {
4344
private val descriptors = mutableMapOf<ParsedDescriptor, PlugDescriptor>()
4445
init {
4546
PlugRegistry.register(socketClass, this)
@@ -97,7 +98,7 @@ abstract class SocketOwner<T>(val socketClass: Class<T>) {
9798
open fun removeHook(plugDescriptor: PlugDescriptor) {}
9899
}
99100

100-
abstract open class Id<T>(socketClass: Class<T>) : SocketOwner<T>(socketClass) {
101+
abstract open class SingletonById<T>(socketClass: Class<T>) : SocketOwner<T>(socketClass) {
101102
private val descriptorById = mutableMapOf<String, PlugDescriptor>()
102103
private val instanceById = mutableMapOf<String, T>()
103104
init {
@@ -125,9 +126,9 @@ abstract class SocketOwner<T>(val socketClass: Class<T>) {
125126
}
126127
}
127128

128-
open fun registerHook(plugDescriptor: PlugDescriptor) {}
129+
open protected fun registerHook(plugDescriptor: PlugDescriptor) {}
129130

130-
open fun removeHook(plugDescriptor: PlugDescriptor) {}
131+
open protected fun removeHook(plugDescriptor: PlugDescriptor) {}
131132

132133
fun allIds() = Collections.unmodifiableSet(descriptorById.keys)
133134

atplug-runtime/src/test/java/com/diffplug/atplug/Fruit.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ package com.diffplug.atplug
33
interface Fruit {
44
@Metadata fun name(): String
55

6-
object Socket : SocketOwner.Id<Fruit>(Fruit::class.java) {
6+
object Socket : SocketOwner.SingletonById<Fruit>(Fruit::class.java) {
77
override fun metadata(plug: Fruit) = mapOf(Pair(KEY_ID, plug.name()))
88
}
99
}

atplug-runtime/src/test/java/com/diffplug/atplug/Shape.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ public interface Shape {
2323
@Metadata
2424
String name();
2525

26-
SocketOwner.Id<Shape> socket = new SocketOwner.Id<Shape>(Shape.class) {
26+
SocketOwner.SingletonById<Shape> socket = new SocketOwner.SingletonById<Shape>(Shape.class) {
2727
@Override
2828
public Map<String, String> metadata(Shape plug) {
2929
Map<String, String> map = new HashMap<>();

0 commit comments

Comments
 (0)