com.moviejukebox.model.enumerations.DirtyFlag.java Source code

Introduction

Here is the source code for com.moviejukebox.model.enumerations.DirtyFlag.java

Source

/*
 *      Copyright (c) 2004-2016 YAMJ Members
 *      https://github.com/orgs/YAMJ/people
 *
 *      This file is part of the Yet Another Movie Jukebox (YAMJ) project.
 *
 *      YAMJ 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.
 *
 *      YAMJ 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 YAMJ.  If not, see <http://www.gnu.org/licenses/>.
 *
 *      Web: https://github.com/YAMJ/yamj-v2
 *
 */
package com.moviejukebox.model.enumerations;

import org.apache.commons.lang3.StringUtils;

/**
 * The list of dirty flags
 *
 * @author Stuart
 */
public enum DirtyFlag {

    /**
     * This is a new movie
     */
    NEW,
    /**
     * The NFO information has changed
     */
    NFO,
    /**
     * The Fanart has changed and may need to be updated/redownloaded
     */
    FANART,
    /**
     * The Poster has changed and may need to be updated/redownloaded
     */
    POSTER,
    /**
     * The Banner has changed and may need to be updated/redownloaded
     */
    BANNER,
    /**
     * The watched value for the video has changed and the information needs to
     * be updated
     */
    WATCHED,
    /**
     * General information about the video has changed that is not specific to
     * one of the other dirty flags
     */
    INFO,
    /**
     * The video has been marked for a recheck.
     *
     * The video should not necessarily need the information to be downloaded
     * from scratch and should instead be considered for update especially for
     * any missing (UNKNOWN) items
     */
    RECHECK,
    /**
     * The ClearArt has changed and may need to be updated/redownloaded
     */
    CLEARART,
    /**
     * The ClearLogo has changed and may need to be updated/redownloaded
     */
    CLEARLOGO,
    /**
     * The TVThumb has changed and may need to be updated/redownloaded
     */
    TVTHUMB,
    /**
     * The SeasonThumb has changed and may need to be updated/redownloaded
     */
    SEASONTHUMB,
    /**
     * The MovieDisc has changed and may need to be updated/redownloaded
     */
    MOVIEDISC;

    /**
     * Convert a string into an Enum type
     *
     * @param dirtyFlag
     * @return
     * @throws IllegalArgumentException If type is not recognised
     *
     */
    public static DirtyFlag fromString(String dirtyFlag) {
        if (StringUtils.isNotBlank(dirtyFlag)) {
            try {
                return DirtyFlag.valueOf(dirtyFlag.trim().toUpperCase());
            } catch (IllegalArgumentException ex) {
                throw new IllegalArgumentException("DirtyFlag " + dirtyFlag + " does not exist.", ex);
            }
        }
        throw new IllegalArgumentException("DirtyFlag must not be null");
    }
}