001/**
002 *
003 * Copyright 2018-2020 Florian Schmaus.
004 *
005 * Licensed under the Apache License, Version 2.0 (the "License");
006 * you may not use this file except in compliance with the License.
007 * You may obtain a copy of the License at
008 *
009 *     http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.jivesoftware.smackx.disco;
018
019import org.jivesoftware.smackx.disco.packet.DiscoverInfo;
020
021import org.jxmpp.jid.Jid;
022
023public abstract class DiscoInfoLookupShortcutMechanism implements Comparable<DiscoInfoLookupShortcutMechanism> {
024
025    private final String name;
026    private final int priority;
027
028    protected DiscoInfoLookupShortcutMechanism(String name, int priority) {
029        this.name = name;
030        this.priority = priority;
031    }
032
033    public final String getName() {
034        return name;
035    }
036
037    /**
038     * Get the priority of this mechanism. Lower values mean higher priority.
039     *
040     * @return the priority of this mechanism.
041     */
042    public final int getPriority() {
043        return priority;
044    }
045
046    public abstract DiscoverInfo getDiscoverInfoByUser(ServiceDiscoveryManager serviceDiscoveryManager, Jid jid);
047
048    @Override
049    public final int compareTo(DiscoInfoLookupShortcutMechanism other) {
050        int ourPriority = getPriority();
051        return Integer.compare(ourPriority, other.getPriority());
052    }
053}