server/core/src/main/java/org/apache/vysper/xmpp/stanza/PresenceStanzaType.java

/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 *
 */

package org.apache.vysper.xmpp.stanza;

/**
 *
 * @author The Apache MINA Project (dev@mina.apache.org)
 */
public enum PresenceStanzaType {

    UNAVAILABLE("unavailable"), SUBSCRIBE("subscribe"), SUBSCRIBED("subscribed"), UNSUBSCRIBE("unsubscribe"), UNSUBSCRIBED(
            "unsubscribed"), PROBE("probe"), ERROR("error");

    private final String value;

    public static PresenceStanzaType valueOfOrNull(String value) {
        try {
            return valueOf(value.toUpperCase());
        } catch (IllegalArgumentException e) {
            return null;
        }
    }

    PresenceStanzaType(String value) {
        this.value = value;
    }

    public String value() {
        return value;
    }

    public static boolean isSubscriptionType(PresenceStanzaType presenceStanzaType) {
        return presenceStanzaType != null
                && (presenceStanzaType == SUBSCRIBE || presenceStanzaType == SUBSCRIBED
                        || presenceStanzaType == UNSUBSCRIBE || presenceStanzaType == UNSUBSCRIBED);
    }

    /**
     * check availability as an implicit presence type -
     * this is given in the absence of any type attribute on the presence stanza
     * @param presenceStanzaType
     * @return
     */
    public static boolean isAvailable(PresenceStanzaType presenceStanzaType) {
        return presenceStanzaType == null;
    }

}