Protest.java

/*
 * Copyright 2010 Chad Retz
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package org.statmantis.model;

import java.util.Map;

import org.statmantis.util.EnumUtils;

/**
 * Representation of a protest for a {@link Game}
 * 
 * @author Chad Retz
 */
public enum Protest implements RetrosheetModel {

    UNIDENTIFIED("P", "Game protested by unidentified team"),
    FAILED_VISITOR("V", "A disallowed protest was made by the visiting team"),
    FAILED_HOME("H", "A disallowed protest was made by the home team"),
    UPHELD_VISITOR("X", "An upheld protest was made by the visiting team"),
    UPHELD_HOME("Y", "An upheld protest was made by the visiting team");
    
    public static final int MAX_LENGTH = 11;
    public static final Map<String, Protest> PROTESTS;
    
    static {
        PROTESTS = EnumUtils.mapEnumerates(Protest.class);
    }
    
    private final String retroId;
    private final String friendlyName;
    
    private Protest(String retroId, String friendlyName) {
        this.retroId = retroId;
        this.friendlyName = friendlyName;
    }
    
    @Override
    public String getRetroId() {
        return retroId;
    }
    
    public String getFriendlyName() {
        return friendlyName;
    }
}