com.tectonica.jonix.common.codelist.BibleTextOrganizations Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jonix-common Show documentation

Collection of enums and other structures unifying Onix2 and Onix3 models

There is a newer version: 2024-10-onix308

/*
 * Copyright (C) 2012-2023 Zach Melamed
 *
 * Latest version available online at https://github.com/zach-m/jonix
 * Contact me at [email protected]
 *
 * 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 com.tectonica.jonix.common.codelist;

import com.tectonica.jonix.common.OnixCodelist;

import java.util.Optional;

/*
 * NOTE: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT MANUALLY
 */

/**
 * marker interface to assist in IDE navigation to code-list 86 (Bible text organization)
 */
interface CodeList86 {
}

/**
 * Enum that corresponds to ONIX Codelist 86
 * 
 * Description: Bible text organization
 *
 * @see About ONIX Codelists
 * @see ONIX
 *      Codelist 86 in Reference Guide
 */
public enum BibleTextOrganizations implements OnixCodelist, CodeList86 {
    /**
     * A Bible with the text organized in the order in which events are believed to have happened
     */
    Chronological("CHR", "Chronological"),

    /**
     * A Bible which explores keywords or themes by referring text to preceding or following text
     */
    Chain_reference("CHA", "Chain reference"),

    /**
     * A Bible or other text in which different versions are printed one line above the other, so that the variations
     * can easily be detected
     */
    Interlinear("INT", "Interlinear"),

    /**
     * A Bible with two or more versions printed side by side
     */
    Parallel("PAR", "Parallel"),

    /**
     * A Bible in which the text is presented in the traditional order
     */
    Standard("STN", "Standard");

    public final String code;
    public final String description;

    BibleTextOrganizations(String code, String description) {
        this.code = code;
        this.description = description;
    }

    @Override
    public String getCode() {
        return code;
    }

    @Override
    public String getDescription() {
        return description;
    }

    public static BibleTextOrganizations byCode(String code) {
        if (code == null || code.isEmpty()) {
            return null;
        }
        for (BibleTextOrganizations e : values()) {
            if (e.code.equals(code)) {
                return e;
            }
        }
        return null;
    }

    public static Optional byCodeOptional(String code) {
        return Optional.ofNullable(byCode(code));
    }

    public static String codeToDesciption(String code) {
        return byCodeOptional(code).map(c -> c.description).orElse(null);
    }
}