gurux.terminal.enums.AvailableMediaSettings Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gurux.terminal Show documentation

gurux.terminal.java package is used to communicate with terminal (modem) connection.

There is a newer version: 1.0.21

//
// --------------------------------------------------------------------------
//  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: http://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.terminal.enums;

import java.util.HashMap;

/**
 * Describes available settings for the media.
 */
public enum AvailableMediaSettings {
    /**
     * All serial port properties are shown.
     */
    ALL(-1),

    /**
     * Is port name shown.
     */
    PORTNAME(0x1),

    /**
     * Is baud rate shown.
     */
    BAUDRATE(0x2),

    /**
     * Is data bits shown.
     */
    DATABITS(0x4),

    /**
     * Is Parity shown.
     */
    PARITY(0x8),

    /**
     * Is stop bits shown.
     */
    STOPBITS(0x10);

    /**
     * Integer value of enumeration.
     */
    private int intValue;

    /**
     * Collection of integer and enumeration values.
     */
    private static java.util.HashMap mappings;

    /**
     * Get mappings.
     * 
     * @return Hash map of enumeration and integer values.
     */
    private static HashMap getMappings() {
        synchronized (AvailableMediaSettings.class) {
            if (mappings == null) {
                mappings = new HashMap();
            }
        }
        return mappings;
    }

    /**
     * Constructor.
     * 
     * @param value
     *            Integer value for enumerator.
     */
    AvailableMediaSettings(final int value) {
        intValue = value;
        synchronized (AvailableMediaSettings.class) {
            getMappings().put(value, this);
        }
    }

    /**
     * Get enemerator's integer value.
     * 
     * @return Integer value of enumerator.
     */
    public int getValue() {
        return intValue;
    }

    /**
     * Get enumerator from integer value.
     * 
     * @param value
     *            integer value.
     * @return Enumerator value.
     */
    public static AvailableMediaSettings forValue(final int value) {
        return getMappings().get(value);
    }
}