From ca7754f55434673337806777250119384873a078 Mon Sep 17 00:00:00 2001 From: david-harley Date: Wed, 13 Jan 2021 11:07:37 +1030 Subject: [PATCH] Added better depricated warning message and clarified some java doc stuff --- .../signal/commands/GetUserStatusCommand.java | 18 ++++++++++++------ .../asamk/signal/commands/ReceiveCommand.java | 17 +++++++++++++++++ .../java/org/asamk/signal/manager/Manager.java | 2 +- 3 files changed, 30 insertions(+), 7 deletions(-) diff --git a/src/main/java/org/asamk/signal/commands/GetUserStatusCommand.java b/src/main/java/org/asamk/signal/commands/GetUserStatusCommand.java index 4200335a..8078de10 100644 --- a/src/main/java/org/asamk/signal/commands/GetUserStatusCommand.java +++ b/src/main/java/org/asamk/signal/commands/GetUserStatusCommand.java @@ -8,6 +8,8 @@ import net.sourceforge.argparse4j.inf.Namespace; import net.sourceforge.argparse4j.inf.Subparser; import org.asamk.signal.manager.Manager; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import java.io.IOException; import java.util.HashSet; @@ -17,6 +19,9 @@ import java.util.stream.Collectors; public class GetUserStatusCommand implements LocalCommand { + // TODO delete later when "json" variable is removed + final static Logger logger = LoggerFactory.getLogger(GetUserStatusCommand.class); + @Override public void attachToSubparser(final Subparser subparser) { subparser.addArgument("number").help("Phone number").nargs("+"); @@ -32,6 +37,13 @@ public class GetUserStatusCommand implements LocalCommand { ObjectMapper jsonProcessor = new ObjectMapper(); jsonProcessor.disable(JsonGenerator.Feature.AUTO_CLOSE_TARGET); + boolean inJson = ns.getString("output").equals("json"); + + // TODO delete later when "json" variable is removed + if (ns.getBoolean("json")) { + logger.warn("\"--json\" option has been deprecated, please use \"output\" instead."); + } + // Get a map of registration statuses Map registered; try { @@ -41,12 +53,6 @@ public class GetUserStatusCommand implements LocalCommand { return 1; } - boolean inJson = ns.getString("output").equals("json"); - if (ns.getBoolean("json")) { - inJson = true; - System.out.println("WARNING: This parameter is now deprecated! Please use the \"output\" parameter instead."); - } - // Output if (inJson) { List objects = registered.entrySet() diff --git a/src/main/java/org/asamk/signal/commands/ReceiveCommand.java b/src/main/java/org/asamk/signal/commands/ReceiveCommand.java index fc844f84..f7a49157 100644 --- a/src/main/java/org/asamk/signal/commands/ReceiveCommand.java +++ b/src/main/java/org/asamk/signal/commands/ReceiveCommand.java @@ -20,6 +20,10 @@ import org.freedesktop.dbus.connections.impl.DBusConnection; import org.freedesktop.dbus.exceptions.DBusException; import org.whispersystems.util.Base64; +// TODO delete later when "json" variable is removed +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + import java.io.IOException; import java.util.concurrent.TimeUnit; @@ -27,6 +31,9 @@ import static org.asamk.signal.util.ErrorUtils.handleAssertionError; public class ReceiveCommand implements ExtendedDbusCommand, LocalCommand { + // TODO delete later when "json" variable is removed + final static Logger logger = LoggerFactory.getLogger(ReceiveCommand.class); + @Override public void attachToSubparser(final Subparser subparser) { subparser.addArgument("-t", "--timeout") @@ -45,6 +52,11 @@ public class ReceiveCommand implements ExtendedDbusCommand, LocalCommand { boolean inJson = ns.getString("output").equals("json") || ns.getBoolean("json"); + // TODO delete later when "json" variable is removed + if (ns.getBoolean("json")) { + logger.warn("\"--json\" option has been deprecated, please use \"output\" instead."); + } + if (inJson) { jsonProcessor = new ObjectMapper(); jsonProcessor.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY); @@ -151,6 +163,11 @@ public class ReceiveCommand implements ExtendedDbusCommand, LocalCommand { public int handleCommand(final Namespace ns, final Manager m) { boolean inJson = ns.getString("output").equals("json") || ns.getBoolean("json"); + // TODO delete later when "json" variable is removed + if (ns.getBoolean("json")) { + logger.warn("\"--json\" option has been deprecated, please use \"output\" instead."); + } + double timeout = 5; if (ns.getDouble("timeout") != null) { timeout = ns.getDouble("timeout"); diff --git a/src/main/java/org/asamk/signal/manager/Manager.java b/src/main/java/org/asamk/signal/manager/Manager.java index 9d090a58..fc7dc864 100644 --- a/src/main/java/org/asamk/signal/manager/Manager.java +++ b/src/main/java/org/asamk/signal/manager/Manager.java @@ -340,7 +340,7 @@ public class Manager implements Closeable { * * @param numbers The set of phone number in question * @return A map of numbers to booleans. True if registered, false otherwise. Should never be null - * @throws IOException if its unable to check if the users are registered + * @throws IOException if its unable to get the contacts to check if they're registered */ public Map areUsersRegistered(Set numbers) throws IOException { // Note "contactDetails" has no optionals. It only gives us info on users who are registered