gurux.dlms.objects.enums.AutoConnectMode Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gurux.dlms Show documentation
gurux.dlms.java package is used to communicate with DLMS devices.
There is a newer version: 4.0.72
//
// --------------------------------------------------------------------------
//  Gurux Ltd
// 
//
//
// Filename:        $HeadURL$
//
// Version:         $Revision$,
//                  $Date$
//                  $Author$
//
// Copyright (c) Gurux Ltd
//
//---------------------------------------------------------------------------
//
//  DESCRIPTION
//
// This file is a part of Gurux Device Framework.
//
// Gurux Device Framework is Open Source software; you can redistribute it
// and/or modify it under the terms of the GNU General Public License 
// as published by the Free Software Foundation; version 2 of the License.
// Gurux Device Framework is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of 
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 
// See the GNU General Public License for more details.
//
// More information of Gurux products: https://www.gurux.org
//
// This code is licensed under the GNU General Public License v2. 
// Full text may be retrieved at http://www.gnu.org/licenses/gpl-2.0.txt
//---------------------------------------------------------------------------

package gurux.dlms.objects.enums;

/**
 * Defines the mode controlling the auto dial functionality concerning the
 * timing.
 */
public enum AutoConnectMode {
    /**
     * No auto dialing,
     */
    NO_AUTO_DIALLING(0),

    /**
     * Auto dialing allowed any time,
     */
    AUTO_DIALLING_ALLOWED_ANYTIME(1),

    /**
     * Auto dialing allowed within the validity time of the calling window.
     */
    AUTO_DIALLING_ALLOWED_CALLING_WINDOW(2),

    /**
     * Regular auto dialing allowed within the validity time of the calling
     * window; alarm initiated auto dialing allowed any time,
     */
    REGULAR_AUTO_DIALLING_ALLOWED_CALLING_WINDOW(3),

    /**
     * SMS sending via Public Land Mobile Network (PLMN),
     */
    SMS_SENDING_PLMN(4),

    /**
     * SMS sending via PSTN.
     */
    SMS_SENDING_PSTN(5),

    /**
     * Email sending.
     */
    EMAIL_SENDING(6),

    /**
     * The device is permanently connected to the communication network.
     */
    PERMANENTLY_CONNECT(101),
    /**
     * The device is permanently connected to the communication network. No
     * connection possible outside the calling window.
     */
    CONNECT_WITH_CALLING_WINDOW(102),
    /**
     * The device is permanently connected to the communication network.
     * Connection is possible as soon as the connect method is invoked.
     */
    CONNECT_INVOKED(103),
    /**
     * The device is usually disconnected. It connects to the communication
     * network as soon as the connect method is invoked
     */
    DISCONNECT_CONNECT_INVOKED(104),

    /**
     * (200..255) manufacturer specific modes
     */
    MANUFACTURE_SPESIFIC(200);

    private int value;
    private static java.util.HashMap mappings;

    private static java.util.HashMap getMappings() {
        synchronized (AutoConnectMode.class) {
            if (mappings == null) {
                mappings = new java.util.HashMap();
            }
        }
        return mappings;
    }

    /*
     * Constructor.
     */
    AutoConnectMode(final int forValue) {
        if (forValue > 200 && forValue < 255) {
            this.value = 200;
        } else {
            this.value = forValue;
        }
        getMappings().put(this.value, this);
    }

    /*
     * Get integer value for enumeration.
     */
    public int getValue() {
        return value;
    }

    /*
     * Convert integer for enumeration value.
     */
    public static AutoConnectMode forValue(final int value) {
        if (value > 200 && value < 255) {
            return MANUFACTURE_SPESIFIC;
        }
        return getMappings().get(value);
    }
}