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 gov.nist.secauto.metaschema.core.configuration.AbstractConfigurationFeature;
030import gov.nist.secauto.metaschema.core.model.IAssemblyDefinition;
031
032import edu.umd.cs.findbugs.annotations.NonNull;
033
034public final class DeserializationFeature<V>
035    extends AbstractConfigurationFeature<V> {
036  public static final int YAML_CODEPOINT_LIMIT_DEFAULT = Integer.MAX_VALUE - 1; // 2 GB
037  public static final int FORMAT_DETECTION_LOOKAHEAD = 32_768; // 2 GB
038
039  /**
040   * If enabled, perform constraint validation on the deserialized bound objects.
041   */
042  @NonNull
043  public static final DeserializationFeature<Boolean> DESERIALIZE_VALIDATE_CONSTRAINTS
044      = new DeserializationFeature<>(Boolean.class, true);
045
046  /**
047   * If enabled, process the next JSON node as a field, whose name must match the
048   * {@link IAssemblyDefinition#getRootJsonName()}. If not enabled, the next JSON
049   * node is expected to be an object containing the data of the
050   * {@link IAssemblyDefinition}.
051   */
052  public static final DeserializationFeature<Boolean> DESERIALIZE_JSON_ROOT_PROPERTY
053      = new DeserializationFeature<>(Boolean.class, true);
054
055  /**
056   * Determines the max YAML codepoints that can be read.
057   */
058  @NonNull
059  public static final DeserializationFeature<Integer> YAML_CODEPOINT_LIMIT
060      = new DeserializationFeature<>(Integer.class, YAML_CODEPOINT_LIMIT_DEFAULT);
061
062  /**
063   * Determines how many bytes can be looked at to identify the format of a
064   * document.
065   */
066  @NonNull
067  public static final DeserializationFeature<Integer> FORMAT_DETECTION_LOOKAHEAD_LIMIT
068      = new DeserializationFeature<>(Integer.class, FORMAT_DETECTION_LOOKAHEAD);
069
070  private DeserializationFeature(
071      @NonNull Class<V> valueClass,
072      @NonNull V defaultValue) {
073    super(valueClass, defaultValue);
074  }
075}