001/* 002 * Portions of this software was developed by employees of the National Institute 003 * of Standards and Technology (NIST), an agency of the Federal Government and is 004 * being made available as a public service. Pursuant to title 17 United States 005 * Code Section 105, works of NIST employees are not subject to copyright 006 * protection in the United States. This software may be subject to foreign 007 * copyright. Permission in the United States and in foreign countries, to the 008 * extent that NIST may hold copyright, to use, copy, modify, create derivative 009 * works, and distribute this software and its documentation without fee is hereby 010 * granted on a non-exclusive basis, provided that this notice and disclaimer 011 * of warranty appears in all copies. 012 * 013 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER 014 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY 015 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF 016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM 017 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE 018 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT 019 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT, 020 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM, 021 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY, 022 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR 023 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT 024 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER. 025 */ 026 027package gov.nist.secauto.metaschema.databind.io; 028 029import java.util.Arrays; 030import java.util.List; 031import java.util.Locale; 032import java.util.stream.Collectors; 033 034import edu.umd.cs.findbugs.annotations.NonNull; 035import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; 036 037/** 038 * Selections of serialization formats. 039 */ 040public enum Format { 041 /** 042 * The <a href="https://www.w3.org/XML/">Extensible Markup Language</a> format. 043 */ 044 XML(".xml"), 045 /** 046 * The <a href="https://www.json.org/">JavaScript Object Notation</a> format. 047 */ 048 JSON(".json"), 049 /** 050 * The <a href="https://yaml.org/">YAML Ain't Markup Language</a> format. 051 */ 052 YAML(".yml"); 053 054 private static final List<String> NAMES; 055 056 @NonNull 057 private final String defaultExtension; 058 059 static { 060 NAMES = Arrays.stream(values()) 061 .map(format -> format.name().toLowerCase(Locale.ROOT)) 062 .collect(Collectors.toUnmodifiableList()); 063 } 064 065 /** 066 * Get a list of all format names in lowercase. 067 * 068 * @return the list of names 069 */ 070 @SuppressFBWarnings(value = "MS_EXPOSE_REP", justification = "Exposes names provided by the enum") 071 public static List<String> names() { 072 return NAMES; 073 } 074 075 Format(@NonNull String defaultExtension) { 076 this.defaultExtension = defaultExtension; 077 } 078 079 /** 080 * Get the default extension to use for the format. 081 * 082 * @return the default extension 083 */ 084 @NonNull 085 public String getDefaultExtension() { 086 return defaultExtension; 087 } 088}