xyz.ottr.lutra.api.StandardFormat Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lutra-api Show documentation

This Lutra submodule is intended for use as a Java library. It has dependencies to all other modules in Lutra, except those that are used for providing executable interfaces, such as command line and REST API interfaces. Lutra is the reference implementation of the OTTR framework. For more information about OTTR, see http://ottr.xyz.

The newest version!

package xyz.ottr.lutra.api;

/*-
 * #%L
 * lutra-cli
 * %%
 * Copyright (C) 2018 - 2020 University of Oslo
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 2.1 of the
 * License, or (at your option) any later version.
 * 
 * This program 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 Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * .
 * #L%
 */

import java.util.Locale;
import xyz.ottr.lutra.bottr.BottrFormat;
import xyz.ottr.lutra.io.Format;
import xyz.ottr.lutra.stottr.StottrFormat;
import xyz.ottr.lutra.tabottr.TabottrFormat;
import xyz.ottr.lutra.wottr.WottrFormat;

public enum StandardFormat {

    // Note: the enum name must ignore-case-match Format.getFormatName().

    wottr(new WottrFormat()),
    stottr(new StottrFormat()),
    tabottr(new TabottrFormat()),
    bottr(new BottrFormat());

    public final Format format;

    StandardFormat(Format f) {
        this.format = f;
        if (!f.getFormatName().equalsIgnoreCase(this.name())) {
            throw new IllegalArgumentException(this.getClass().getSimpleName() + " " + name()
                + " does not match format name " + f.getFormatName() + ".");
        }
    }

    public String toString() {
        return this.format.getFormatName().toLowerCase(Locale.getDefault());
    }
}