com.omertron.omdbapi.tools.OmdbParameters Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of API-OMDB Show documentation
API for the omdbapi.com website
There is a newer version: 1.5
/*
 *      Copyright (c) 2013-2016 Stuart Boston
 *
 *      This file is part of the OMDB API.
 *
 *      The OMDB API 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 OMDB API 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 OMDB API.  If not, see .
 *
 */
package com.omertron.omdbapi.tools;

import com.omertron.omdbapi.emumerations.DataType;
import com.omertron.omdbapi.emumerations.PlotType;
import com.omertron.omdbapi.emumerations.ResultType;
import java.util.EnumMap;
import java.util.Map;
import org.apache.commons.lang3.builder.ToStringBuilder;
import org.apache.commons.lang3.builder.ToStringStyle;

/**
 * Parameters for the OMDB API
 *
 * @author Stuart
 */
public class OmdbParameters {

    private final Map parameters = new EnumMap(Param.class);
    // Defaults for parameters
    private final Map defaults = new EnumMap(Param.class);

    /**
     * Construct an empty set of parameters
     */
    public OmdbParameters() {
        defaults.put(Param.VERSION, 1);
        defaults.put(Param.PLOT, PlotType.getDefault());
        defaults.put(Param.TOMATOES, false);
        defaults.put(Param.RESULT, ResultType.getDefault());
        defaults.put(Param.DATA, DataType.getDefault());
    }

    /**
     * Add a parameter to the collection
     *
     * @param key Parameter to add
     * @param value The value to use
     */
    public void add(Param key, Object value) {
        // check to see if we have a default value and skip it
        if (defaults.containsKey(key) && defaults.get(key).equals(value)) {
            // We already have this value, so skip it
            return;
        }
        parameters.put(key, value);
    }

    /**
     * Check to see if the collection has a certain parameter
     *
     * @param key The Parameter to check
     * @return
     */
    public boolean has(Param key) {
        return parameters.containsKey(key);
    }

    /**
     * Get a parameter from the collection
     *
     * @param key The parameter to get
     * @return
     */
    public Object get(Param key) {
        return parameters.get(key);
    }

    /**
     * Remove a parameter from the collection
     *
     * @param key
     */
    public void remove(Param key) {
        parameters.remove(key);
    }

    /**
     * Check to see if the collection has no items
     *
     * @return
     */
    public boolean isEmpty() {
        return parameters.isEmpty();
    }

    /**
     * Check to see if the collection has items
     *
     * @return
     */
    public boolean isNotEmpty() {
        return !isEmpty();
    }

    @Override
    public String toString() {
        return ToStringBuilder.reflectionToString(parameters, ToStringStyle.SHORT_PREFIX_STYLE);
    }
}