com.tectonica.jonix.common.codelist.ContentDateRoles Maven / Gradle / Ivy
Show all versions of jonix-common Show documentation
/*
* 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.HashMap;
import java.util.Map;
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 155 (Content date role)
*/
interface CodeList155 {
}
/**
* Enum that corresponds to ONIX Codelist 155
*
* Description: Content date role
*
* @see About ONIX Codelists
* @see ONIX
* Codelist 155 in Reference Guide
*/
public enum ContentDateRoles implements OnixCodelist, CodeList155 {
/**
* Nominal date of publication (of the content item or supporting resource)
*/
Publication_date("01", "Publication date"),
/**
* Date when a TV or radio program was / will be broadcast
*/
Broadcast_date("04", "Broadcast date"),
/**
* Date from which a content item or supporting resource may be referenced or used. The content is embargoed until
* this date
*/
From_date("14", "From date"),
/**
* Date until which a content item or supporting resource may be referenced or used
*/
Until_date("15", "Until date"),
/**
* Date when a resource was last changed or updated
*/
Last_updated("17", "Last updated"),
/**
* Combines From date and Until date to define a period (both dates are inclusive). Use for example with dateformat
* 06
*/
From_until_date("24", "From… until date"),
/**
* Date from which a supporting resource is available for download. Note that this date also implies that it can be
* immediately displayed to the intended audience, unless a From date (code 14) is also supplied and is later than
* the Available from date
*/
Available_from("27", "Available from"),
/**
* Date until which a supporting resource is available for download. Note that this date does not imply it must be
* removed from display to the intended audience on this date - for this, use Until date (code 15)
*/
Available_until("28", "Available until"),
/**
* Start date referenced by the supporting resource, for example, the 'earliest exam date' for an official
* recommendation
*
* Jonix-Comment: Introduced in Onix3
*/
Associated_start_date("31", "Associated start date"),
/**
* End date referenced by the supporting resource, for example, the 'latest exam date' for an official
* recommendation
*
* Jonix-Comment: Introduced in Onix3
*/
Associated_end_date("32", "Associated end date");
public final String code;
public final String description;
ContentDateRoles(String code, String description) {
this.code = code;
this.description = description;
}
@Override
public String getCode() {
return code;
}
@Override
public String getDescription() {
return description;
}
private static volatile Map map;
private static Map map() {
Map result = map;
if (result == null) {
synchronized (ContentDateRoles.class) {
result = map;
if (result == null) {
result = new HashMap<>();
for (ContentDateRoles e : values()) {
result.put(e.code, e);
}
map = result;
}
}
}
return result;
}
public static ContentDateRoles byCode(String code) {
if (code == null || code.isEmpty()) {
return null;
}
return map().get(code);
}
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);
}
}