1 /* 2 * Portions of this software was developed by employees of the National Institute 3 * of Standards and Technology (NIST), an agency of the Federal Government and is 4 * being made available as a public service. Pursuant to title 17 United States 5 * Code Section 105, works of NIST employees are not subject to copyright 6 * protection in the United States. This software may be subject to foreign 7 * copyright. Permission in the United States and in foreign countries, to the 8 * extent that NIST may hold copyright, to use, copy, modify, create derivative 9 * works, and distribute this software and its documentation without fee is hereby 10 * granted on a non-exclusive basis, provided that this notice and disclaimer 11 * of warranty appears in all copies. 12 * 13 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER 14 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY 15 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM 17 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE 18 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT 19 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT, 20 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM, 21 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY, 22 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR 23 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT 24 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER. 25 */ 26 27 package gov.nist.secauto.metaschema.databind.io; 28 29 import java.util.Arrays; 30 import java.util.List; 31 import java.util.Locale; 32 import java.util.stream.Collectors; 33 34 import edu.umd.cs.findbugs.annotations.NonNull; 35 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; 36 37 /** 38 * Selections of serialization formats. 39 */ 40 public enum Format { 41 /** 42 * The <a href="https://www.w3.org/XML/">Extensible Markup Language</a> format. 43 */ 44 XML(".xml"), 45 /** 46 * The <a href="https://www.json.org/">JavaScript Object Notation</a> format. 47 */ 48 JSON(".json"), 49 /** 50 * The <a href="https://yaml.org/">YAML Ain't Markup Language</a> format. 51 */ 52 YAML(".yml"); 53 54 private static final List<String> NAMES; 55 56 @NonNull 57 private final String defaultExtension; 58 59 static { 60 NAMES = Arrays.stream(values()) 61 .map(format -> format.name().toLowerCase(Locale.ROOT)) 62 .collect(Collectors.toUnmodifiableList()); 63 } 64 65 /** 66 * Get a list of all format names in lowercase. 67 * 68 * @return the list of names 69 */ 70 @SuppressFBWarnings(value = "MS_EXPOSE_REP", justification = "Exposes names provided by the enum") 71 public static List<String> names() { 72 return NAMES; 73 } 74 75 Format(@NonNull String defaultExtension) { 76 this.defaultExtension = defaultExtension; 77 } 78 79 /** 80 * Get the default extension to use for the format. 81 * 82 * @return the default extension 83 */ 84 @NonNull 85 public String getDefaultExtension() { 86 return defaultExtension; 87 } 88 }