ContentType.java

// <editor-fold defaultstate="collapsed" desc="license">
/*
 * Copyright (c) 2009, Karl H. Beckers
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * * Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 * * Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 * * Neither the name of the <ORGANIZATION> nor the names of its contributors
 *   may be used to endorse or promote products derived from this software
 *   without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 **/
// </editor-fold>
package net.jarre_de_the.griffin.file;

/**
 * An enumeration of the file types NWN knows.
 * <p>
 * @author charly4711
 */
public enum ContentType {

    BINARY(null, "Binary file format. Details vary widely as to implementation"),
    TEXT(String.class, "Plain text file. For some text resources, it doesn't matter whether lines are terminated "
         + "by CR+LF or just CR characters, but for other text resources, it might matter. To avoid "
         + "complications, always use CR+LF line terminators because that at least will work in all cases."),
    TWODA(TwoDa.class , "For Bioware this is a text resource, but we want it to have its own class"),
    INI(String.class, "Windows INI file format. Special case of a text file."),
    GFF(Gff.class, "BioWare Generic File Format. See the Generic File Format document."),
    MDL(null, "BioWare Aurora model file format. Can be plain text or binary.");

    private final Class clazz;
    private final String description;

    private ContentType(Class clazz, String description) {
        this.clazz = clazz;
        this.description = description;
    }

    /**
     *
     * @return The class that corresponds to the file type in question (or null, if there is none).
     */
    public Class typeClass() {
        return clazz;
    }

    /**
     *
     * @return A String description of the file type as per Bioware documentation. This is not used at the moment.
     */
    public String description() {
        return description;
    }
}