From 69767e953871c4bc61c1cde6de22905997144946 Mon Sep 17 00:00:00 2001 From: Florian Schmaus Date: Tue, 29 Oct 2019 19:21:31 +0100 Subject: [PATCH] Rename AbstractIqBuilder subclasses to their designated names --- .../smack/packet/AbstractIqBuilder.java | 10 +++---- .../smack/packet/EmptyResultIQ.java | 2 +- .../org/jivesoftware/smack/packet/IQ.java | 2 +- .../jivesoftware/smack/packet/IqBuilder.java | 25 +++++++---------- .../{IqBuilderWithBuild.java => IqData.java} | 27 +++++++++---------- .../jivesoftware/smack/packet/SimpleIQ.java | 2 +- .../smack/packet/StanzaBuilder.java | 4 +-- .../smack/packet/StanzaFactory.java | 4 +-- .../smack/provider/IQProvider.java | 4 +-- .../smack/provider/IqProvider.java | 8 +++--- .../smack/util/PacketParserUtils.java | 4 +-- .../iot/control/element/IoTSetResponse.java | 4 +-- .../smackx/disco/packet/DiscoverInfo.java | 8 +++--- .../disco/packet/DiscoverInfoBuilder.java | 6 ++--- .../disco/provider/DiscoverInfoProvider.java | 4 +-- .../jivesoftware/smackx/ping/packet/Ping.java | 8 +++--- 16 files changed, 58 insertions(+), 64 deletions(-) rename smack-core/src/main/java/org/jivesoftware/smack/packet/{IqBuilderWithBuild.java => IqData.java} (59%) diff --git a/smack-core/src/main/java/org/jivesoftware/smack/packet/AbstractIqBuilder.java b/smack-core/src/main/java/org/jivesoftware/smack/packet/AbstractIqBuilder.java index 479bcb346..d975db0ef 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/packet/AbstractIqBuilder.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/packet/AbstractIqBuilder.java @@ -36,21 +36,21 @@ public abstract class AbstractIqBuilder> extend super(stanzaId); } - public static IqBuilder createResponse(IqView request) { + public static IqData createResponse(IqView request) { return createResponse(request, IQ.ResponseType.result); } - public static IqBuilder createErrorResponse(IqView request) { + public static IqData createErrorResponse(IqView request) { return createResponse(request, IQ.ResponseType.error); } - protected static IqBuilder createResponse(IqView request, IQ.ResponseType responseType) { + protected static IqData createResponse(IqView request, IQ.ResponseType responseType) { if (!(request.getType() == IQ.Type.get || request.getType() == IQ.Type.set)) { throw new IllegalArgumentException("IQ request must be of type 'set' or 'get'. Original IQ: " + request); } - IqBuilder commonResponseIqData = buildResponse(request, s -> { - return StanzaBuilder.buildIq(s); + IqData commonResponseIqData = buildResponse(request, s -> { + return StanzaBuilder.buildIqData(s); }); commonResponseIqData.ofType(responseType.getType()); diff --git a/smack-core/src/main/java/org/jivesoftware/smack/packet/EmptyResultIQ.java b/smack-core/src/main/java/org/jivesoftware/smack/packet/EmptyResultIQ.java index 933bf089f..248f0ebaa 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/packet/EmptyResultIQ.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/packet/EmptyResultIQ.java @@ -18,7 +18,7 @@ package org.jivesoftware.smack.packet; public class EmptyResultIQ extends IQ { - EmptyResultIQ(IqBuilder iqBuilder) { + EmptyResultIQ(IqData iqBuilder) { super(iqBuilder, null, null); } diff --git a/smack-core/src/main/java/org/jivesoftware/smack/packet/IQ.java b/smack-core/src/main/java/org/jivesoftware/smack/packet/IQ.java index db76ecdaa..0dd9ca521 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/packet/IQ.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/packet/IQ.java @@ -65,7 +65,7 @@ public abstract class IQ extends Stanza implements IqView { // TODO: Deprecate when stanza builder is ready. protected IQ(String childElementName, String childElementNamespace) { - this(IqBuilder.EMPTY, childElementName, childElementNamespace); + this(IqData.EMPTY, childElementName, childElementNamespace); } protected IQ(AbstractIqBuilder iqBuilder, String childElementName, String childElementNamespace) { diff --git a/smack-core/src/main/java/org/jivesoftware/smack/packet/IqBuilder.java b/smack-core/src/main/java/org/jivesoftware/smack/packet/IqBuilder.java index e1bc905a2..2e24f53b2 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/packet/IqBuilder.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/packet/IqBuilder.java @@ -16,34 +16,29 @@ */ package org.jivesoftware.smack.packet; -import org.jivesoftware.smack.packet.id.StandardStanzaIdSource; -import org.jivesoftware.smack.packet.id.StanzaIdSource; +import org.jivesoftware.smack.XMPPConnection; import org.jivesoftware.smack.util.Objects; -// TODO: Rename to IqData. -public final class IqBuilder extends AbstractIqBuilder { +public abstract class IqBuilder, I extends IQ> + extends AbstractIqBuilder { - static final IqBuilder EMPTY = new IqBuilder(StandardStanzaIdSource.DEFAULT); - - IqBuilder(IqBuilder other) { + protected IqBuilder(AbstractIqBuilder other) { super(other); } - IqBuilder(StanzaIdSource stanzaIdSource) { - super(stanzaIdSource); + protected IqBuilder(XMPPConnection connection) { + super(connection.getStanzaFactory().getStanzaIdSource()); } - IqBuilder(String stanzaId) { + protected IqBuilder(String stanzaId) { super(stanzaId); } - public IqBuilder ofType(IQ.Type type) { + public IB ofType(IQ.Type type) { this.type = Objects.requireNonNull(type); return getThis(); } - @Override - public IqBuilder getThis() { - return this; - } + public abstract I build(); + } diff --git a/smack-core/src/main/java/org/jivesoftware/smack/packet/IqBuilderWithBuild.java b/smack-core/src/main/java/org/jivesoftware/smack/packet/IqData.java similarity index 59% rename from smack-core/src/main/java/org/jivesoftware/smack/packet/IqBuilderWithBuild.java rename to smack-core/src/main/java/org/jivesoftware/smack/packet/IqData.java index 5d8c993de..deba5486e 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/packet/IqBuilderWithBuild.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/packet/IqData.java @@ -16,30 +16,29 @@ */ package org.jivesoftware.smack.packet; -import org.jivesoftware.smack.XMPPConnection; +import org.jivesoftware.smack.packet.id.StandardStanzaIdSource; +import org.jivesoftware.smack.packet.id.StanzaIdSource; import org.jivesoftware.smack.util.Objects; -// TODO: Rename to IqBuilder. -public abstract class IqBuilderWithBuild, I extends IQ> - extends AbstractIqBuilder { +public final class IqData extends AbstractIqBuilder { - protected IqBuilderWithBuild(AbstractIqBuilder other) { - super(other); + static final IqData EMPTY = new IqData(StandardStanzaIdSource.DEFAULT); + + IqData(StanzaIdSource stanzaIdSource) { + super(stanzaIdSource); } - protected IqBuilderWithBuild(XMPPConnection connection) { - super(connection.getStanzaFactory().getStanzaIdSource()); - } - - protected IqBuilderWithBuild(String stanzaId) { + IqData(String stanzaId) { super(stanzaId); } - public IB ofType(IQ.Type type) { + public IqData ofType(IQ.Type type) { this.type = Objects.requireNonNull(type); return getThis(); } - public abstract I build(); - + @Override + public IqData getThis() { + return this; + } } diff --git a/smack-core/src/main/java/org/jivesoftware/smack/packet/SimpleIQ.java b/smack-core/src/main/java/org/jivesoftware/smack/packet/SimpleIQ.java index 5cd260c5f..f230949fd 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/packet/SimpleIQ.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/packet/SimpleIQ.java @@ -29,7 +29,7 @@ public abstract class SimpleIQ extends IQ { super(childElementName, childElementNamespace); } - protected SimpleIQ(IqBuilder iqBuilder, String childElementName, String childElementNamespace) { + protected SimpleIQ(IqData iqBuilder, String childElementName, String childElementNamespace) { super(iqBuilder, childElementName, childElementNamespace); } diff --git a/smack-core/src/main/java/org/jivesoftware/smack/packet/StanzaBuilder.java b/smack-core/src/main/java/org/jivesoftware/smack/packet/StanzaBuilder.java index ec150e005..3539d22bd 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/packet/StanzaBuilder.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/packet/StanzaBuilder.java @@ -289,8 +289,8 @@ public abstract class StanzaBuilder> implements Stanz return new PresenceBuilder(presence, stanzaIdSource); } - public static IqBuilder buildIq(String stanzaId) { - return new IqBuilder(stanzaId); + public static IqData buildIqData(String stanzaId) { + return new IqData(stanzaId); } public static > SB buildResponse(StanzaView request, Function builderFromStanzaId) { diff --git a/smack-core/src/main/java/org/jivesoftware/smack/packet/StanzaFactory.java b/smack-core/src/main/java/org/jivesoftware/smack/packet/StanzaFactory.java index 738477cf7..9f69ee638 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/packet/StanzaFactory.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/packet/StanzaFactory.java @@ -46,8 +46,8 @@ public final class StanzaFactory { return new PresenceBuilder(presence, stanzaIdSource); } - public IqBuilder buildIqStanza() { - return new IqBuilder(stanzaIdSource); + public IqData buildIqData() { + return new IqData(stanzaIdSource); } } diff --git a/smack-core/src/main/java/org/jivesoftware/smack/provider/IQProvider.java b/smack-core/src/main/java/org/jivesoftware/smack/provider/IQProvider.java index 514b3e875..d0e1f8fc3 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/provider/IQProvider.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/provider/IQProvider.java @@ -20,7 +20,7 @@ package org.jivesoftware.smack.provider; import java.io.IOException; import org.jivesoftware.smack.packet.IQ; -import org.jivesoftware.smack.packet.IqBuilder; +import org.jivesoftware.smack.packet.IqData; import org.jivesoftware.smack.packet.XmlEnvironment; import org.jivesoftware.smack.parsing.SmackParsingException; import org.jivesoftware.smack.util.ParserUtils; @@ -58,7 +58,7 @@ public abstract class IQProvider extends IqProvider { } @Override - public final I parse(XmlPullParser parser, int initialDepth, IqBuilder iqData, XmlEnvironment xmlEnvironment) + public final I parse(XmlPullParser parser, int initialDepth, IqData iqData, XmlEnvironment xmlEnvironment) throws XmlPullParserException, IOException, SmackParsingException { // Old-style IQ parsers do not need IqData. return parse(parser, initialDepth, xmlEnvironment); diff --git a/smack-core/src/main/java/org/jivesoftware/smack/provider/IqProvider.java b/smack-core/src/main/java/org/jivesoftware/smack/provider/IqProvider.java index cab79ee72..14ceecd15 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/provider/IqProvider.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/provider/IqProvider.java @@ -19,7 +19,7 @@ package org.jivesoftware.smack.provider; import java.io.IOException; import org.jivesoftware.smack.packet.IQ; -import org.jivesoftware.smack.packet.IqBuilder; +import org.jivesoftware.smack.packet.IqData; import org.jivesoftware.smack.packet.XmlEnvironment; import org.jivesoftware.smack.parsing.SmackParsingException; import org.jivesoftware.smack.xml.XmlPullParser; @@ -27,12 +27,12 @@ import org.jivesoftware.smack.xml.XmlPullParserException; public abstract class IqProvider extends AbstractProvider { - public final I parse(XmlPullParser parser, IqBuilder iqCommon) + public final I parse(XmlPullParser parser, IqData iqCommon) throws XmlPullParserException, IOException, SmackParsingException { return parse(parser, iqCommon, null); } - public final I parse(XmlPullParser parser, IqBuilder iqData, XmlEnvironment outerXmlEnvironment) + public final I parse(XmlPullParser parser, IqData iqData, XmlEnvironment outerXmlEnvironment) throws XmlPullParserException, IOException, SmackParsingException { final int initialDepth = parser.getDepth(); final XmlEnvironment xmlEnvironment = XmlEnvironment.from(parser, outerXmlEnvironment); @@ -40,7 +40,7 @@ public abstract class IqProvider extends AbstractProvider { return parse(parser, initialDepth, iqData, xmlEnvironment); } - public abstract I parse(XmlPullParser parser, int initialDepth, IqBuilder iqData, XmlEnvironment xmlEnvironment) + public abstract I parse(XmlPullParser parser, int initialDepth, IqData iqData, XmlEnvironment xmlEnvironment) throws XmlPullParserException, IOException, SmackParsingException; } diff --git a/smack-core/src/main/java/org/jivesoftware/smack/util/PacketParserUtils.java b/smack-core/src/main/java/org/jivesoftware/smack/util/PacketParserUtils.java index eb7833f12..a3553475c 100644 --- a/smack-core/src/main/java/org/jivesoftware/smack/util/PacketParserUtils.java +++ b/smack-core/src/main/java/org/jivesoftware/smack/util/PacketParserUtils.java @@ -36,7 +36,7 @@ import org.jivesoftware.smack.packet.EmptyResultIQ; import org.jivesoftware.smack.packet.ErrorIQ; import org.jivesoftware.smack.packet.ExtensionElement; import org.jivesoftware.smack.packet.IQ; -import org.jivesoftware.smack.packet.IqBuilder; +import org.jivesoftware.smack.packet.IqData; import org.jivesoftware.smack.packet.Message; import org.jivesoftware.smack.packet.MessageBuilder; import org.jivesoftware.smack.packet.Presence; @@ -543,7 +543,7 @@ public class PacketParserUtils { StanzaError error = null; final String id = parser.getAttributeValue("", "id"); - IqBuilder iqData = StanzaBuilder.buildIq(id); + IqData iqData = StanzaBuilder.buildIqData(id); final Jid to = ParserUtils.getJidAttribute(parser, "to"); iqData.to(to); diff --git a/smack-experimental/src/main/java/org/jivesoftware/smackx/iot/control/element/IoTSetResponse.java b/smack-experimental/src/main/java/org/jivesoftware/smackx/iot/control/element/IoTSetResponse.java index ef4513d1e..1d64aebeb 100644 --- a/smack-experimental/src/main/java/org/jivesoftware/smackx/iot/control/element/IoTSetResponse.java +++ b/smack-experimental/src/main/java/org/jivesoftware/smackx/iot/control/element/IoTSetResponse.java @@ -18,14 +18,14 @@ package org.jivesoftware.smackx.iot.control.element; import org.jivesoftware.smack.packet.AbstractIqBuilder; import org.jivesoftware.smack.packet.IQ; -import org.jivesoftware.smack.packet.IqBuilder; +import org.jivesoftware.smack.packet.IqData; public class IoTSetResponse extends IQ { public static final String ELEMENT = "setResponse"; public static final String NAMESPACE = Constants.IOT_CONTROL_NAMESPACE; - public IoTSetResponse(IqBuilder iqBuilder) { + public IoTSetResponse(IqData iqBuilder) { super(iqBuilder, ELEMENT, NAMESPACE); } diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/packet/DiscoverInfo.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/packet/DiscoverInfo.java index 6f47bb9d3..0213d99b8 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/packet/DiscoverInfo.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/packet/DiscoverInfo.java @@ -26,7 +26,7 @@ import java.util.Set; import org.jivesoftware.smack.XMPPConnection; import org.jivesoftware.smack.packet.IQ; -import org.jivesoftware.smack.packet.IqBuilder; +import org.jivesoftware.smack.packet.IqData; import org.jivesoftware.smack.util.EqualsUtil; import org.jivesoftware.smack.util.HashCode; import org.jivesoftware.smack.util.StringUtils; @@ -148,7 +148,7 @@ public class DiscoverInfo extends IQ implements DiscoverInfoView, TypedCloneable * * @param feature the future. * @return true if the feature is new. - * @deprecated use {@link DiscoverInfoBuilder#addFeature(Feature)} instead. + * @deprecated use {@link DiscoverInfoBuilder#addFeature(DiscoverInfo.Feature)} instead. */ @Deprecated // TODO: Remove in Smack 4.5. @@ -170,7 +170,7 @@ public class DiscoverInfo extends IQ implements DiscoverInfoView, TypedCloneable * Adds a new identity of the requested entity to the discovered information. * * @param identity the discovered entity's identity - * @deprecated use {@link DiscoverInfoBuilder#addIdentity(Identity)} instead. + * @deprecated use {@link DiscoverInfoBuilder#addIdentity(DiscoverInfo.Identity)} instead. */ @Deprecated // TODO: Remove in Smack 4.5. @@ -313,7 +313,7 @@ public class DiscoverInfo extends IQ implements DiscoverInfoView, TypedCloneable return new DiscoverInfoBuilder(connection); } - public static DiscoverInfoBuilder builder(IqBuilder iqData) { + public static DiscoverInfoBuilder builder(IqData iqData) { return new DiscoverInfoBuilder(iqData); } diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/packet/DiscoverInfoBuilder.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/packet/DiscoverInfoBuilder.java index 3f4f25578..66f965de4 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/packet/DiscoverInfoBuilder.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/disco/packet/DiscoverInfoBuilder.java @@ -23,12 +23,12 @@ import java.util.List; import org.jivesoftware.smack.XMPPConnection; import org.jivesoftware.smack.packet.IQ; import org.jivesoftware.smack.packet.IqBuilder; -import org.jivesoftware.smack.packet.IqBuilderWithBuild; +import org.jivesoftware.smack.packet.IqData; import org.jivesoftware.smackx.disco.packet.DiscoverInfo.Feature; import org.jivesoftware.smackx.disco.packet.DiscoverInfo.Identity; -public class DiscoverInfoBuilder extends IqBuilderWithBuild +public class DiscoverInfoBuilder extends IqBuilder implements DiscoverInfoView { private final List features = new ArrayList<>(); @@ -36,7 +36,7 @@ public class DiscoverInfoBuilder extends IqBuilderWithBuild { @Override - public DiscoverInfo parse(XmlPullParser parser, int initialDepth, IqBuilder iqData, XmlEnvironment xmlEnvironment) + public DiscoverInfo parse(XmlPullParser parser, int initialDepth, IqData iqData, XmlEnvironment xmlEnvironment) throws XmlPullParserException, IOException, SmackParsingException { DiscoverInfoBuilder discoverInfoBuilder = DiscoverInfo.builder(iqData); diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/ping/packet/Ping.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/ping/packet/Ping.java index 13803354c..ac46a76c4 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/ping/packet/Ping.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/ping/packet/Ping.java @@ -18,7 +18,7 @@ package org.jivesoftware.smackx.ping.packet; import org.jivesoftware.smack.XMPPConnection; import org.jivesoftware.smack.packet.IQ; -import org.jivesoftware.smack.packet.IqBuilder; +import org.jivesoftware.smack.packet.IqData; import org.jivesoftware.smack.packet.SimpleIQ; import org.jxmpp.jid.Jid; @@ -39,14 +39,14 @@ public class Ping extends SimpleIQ { } public Ping(XMPPConnection connection, Jid to) { - this(connection.getStanzaFactory().buildIqStanza(), to); + this(connection.getStanzaFactory().buildIqData(), to); } - public Ping(IqBuilder iqBuilder, Jid to) { + public Ping(IqData iqBuilder, Jid to) { super(iqBuilder.to(to).ofType(IQ.Type.get), ELEMENT, NAMESPACE); } - public Ping(IqBuilder iqBuilder) { + public Ping(IqData iqBuilder) { super(iqBuilder, ELEMENT, NAMESPACE); }