com.omertron.bgg.enums.Command.java Source code

Introduction

Here is the source code for com.omertron.bgg.enums.Command.java

Source

/*
 *      Copyright (c) 2017 Stuart Boston
 *
 *      This file is part of the Board Game Geek API Wrapper.
 *
 *      This API wrapper is free 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, either version 3 of the License, or
 *      any later version.
 *
 *      The API wrapper 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.
 *
 *      You should have received a copy of the GNU General Public License
 *      along with the API Wrapper.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
package com.omertron.bgg.enums;

import org.apache.commons.lang3.StringUtils;

/**
 *
 * @author Omertron
 */
public enum Command {
    /**
     * In the BGG database, any physical, tangible product is called a thing
     */
    THING,
    /**
     * In the BGG database, more abstract or esoteric concepts are represented
     * by something called a family.
     */
    FAMILY,
    /**
     * Request a list of forums for a particular type/id
     */
    FORUMLIST,
    /**
     * Request a list of threads in a particular forum
     */
    FORUM,
    /**
     * Request forum threads by thread id.
     *
     * A thread consists of some basic information about the thread and a series
     * of articles or individual postings.
     */
    THREAD,
    /**
     * Request basic public profile information about a user by username
     */
    USER,
    /**
     * Request information about particular guilds.
     */
    GUILD,
    /**
     * Request plays logged by a particular user or for a particular item.
     */
    PLAYS,
    /**
     * Request details about a user's collection.
     */
    COLLECTION,
    /**
     * You can retrieve the list of most active items on the site.
     */
    HOT,
    /**
     * You can search for items from the database by name.
     */
    SEARCH;

    /**
     * Convert a string into an Enum type
     *
     * @param source String representation of the enum to convert
     * @return The enum that matches the source
     * @throws IllegalArgumentException If type is not recognised
     *
     */
    public static Command fromString(String source) {
        if (StringUtils.isNotBlank(source)) {
            try {
                return Command.valueOf(source.trim().toUpperCase());
            } catch (IllegalArgumentException ex) {
                throw new IllegalArgumentException("Command " + source + " does not exist.", ex);
            }
        }
        throw new IllegalArgumentException("Command must not be null");
    }

    @Override
    public String toString() {
        return this.name().toLowerCase();
    }
}