org.theta4j.data.ChannelNumber Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of theta4j Show documentation

theta4j is a library for RICOH THETA written in Java.

The newest version!

/*
 * Copyright (C) 2015 theta4j project
 */

package org.theta4j.data;

import org.theta4j.ptp.type.UINT8;
import org.theta4j.util.Validators;

import java.util.HashMap;
import java.util.Map;

/**
 * The enum represents the channel number of Wi-Fi.
 */
public enum ChannelNumber {
    /**
     * Wi-Fi channel is determined at random.
     */
    RANDOM(0),
    /**
     * Wi-Fi channel is 1.
     */
    CH_1(1),
    /**
     * Wi-Fi channel is 6.
     */
    CH_6(6),
    /**
     * Wi-Fi channel is 11.
     */
    CH_11(11);

    // Map for valueOf method

    private static final Map CHANNEL_NUMBER_MAP = new HashMap<>();

    static {
        for (ChannelNumber channelNumber : ChannelNumber.values()) {
            CHANNEL_NUMBER_MAP.put(channelNumber.value, channelNumber);
        }
    }

    // Property

    private final UINT8 value;

    // Constructor

    ChannelNumber(int value) {
        this.value = new UINT8(value);
    }

    // Getter

    /**
     * Returns the integer value according THETA API v1.
     */
    public UINT8 value() {
        return value;
    }

    // valueOf

    /**
     * Returns the channel number enum from the integer value defined by THETA API v1.
     */
    public static ChannelNumber valueOf(UINT8 value) {
        Validators.notNull("value", value);

        if (!CHANNEL_NUMBER_MAP.containsKey(value)) {
            throw new IllegalArgumentException("Unknown ChannelNumber Value: " + value);
        }

        return CHANNEL_NUMBER_MAP.get(value);
    }
}