From 831e4bcbcc2c4ad1a84cfd806a2f9ab8d75da55b Mon Sep 17 00:00:00 2001 From: Christian Basler Date: Mon, 14 Nov 2016 23:27:29 +0100 Subject: [PATCH] Added clarifying comment --- .../ch/dissem/bitmessage/ports/AddressRepository.java | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/core/src/main/java/ch/dissem/bitmessage/ports/AddressRepository.java b/core/src/main/java/ch/dissem/bitmessage/ports/AddressRepository.java index ff397ba..ae0a249 100644 --- a/core/src/main/java/ch/dissem/bitmessage/ports/AddressRepository.java +++ b/core/src/main/java/ch/dissem/bitmessage/ports/AddressRepository.java @@ -21,6 +21,14 @@ import ch.dissem.bitmessage.entity.BitmessageAddress; import java.util.List; public interface AddressRepository { + /** + * Returns a matching BitmessageAddress if there is one with the given ripe or tag, that + * has no public key yet. If it doesn't exist or already has a public key, null is returned. + * + * @param ripeOrTag Either ripe or tag (depending of address version) of an address with + * missing public key. + * @return the matching address if there is one without public key, or null otherwise. + */ BitmessageAddress findContact(byte[] ripeOrTag); BitmessageAddress findIdentity(byte[] ripeOrTag);