View Javadoc
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 gov.nist.secauto.metaschema.core.configuration.DefaultConfiguration;
30  import gov.nist.secauto.metaschema.core.configuration.IConfigurationFeature;
31  import gov.nist.secauto.metaschema.core.configuration.IMutableConfiguration;
32  import gov.nist.secauto.metaschema.core.util.ObjectUtils;
33  import gov.nist.secauto.metaschema.databind.IBindingContext;
34  import gov.nist.secauto.metaschema.databind.model.IAssemblyClassBinding;
35  
36  import java.util.Map;
37  
38  import edu.umd.cs.findbugs.annotations.NonNull;
39  
40  @SuppressWarnings("PMD.ReplaceVectorWithList") // false positive
41  abstract class AbstractSerializationBase<T extends IConfigurationFeature<?>>
42      implements IMutableConfiguration<T> {
43    @NonNull
44    private final IAssemblyClassBinding classBinding;
45    @NonNull
46    private final DefaultConfiguration<T> configuration;
47  
48    protected AbstractSerializationBase(@NonNull IAssemblyClassBinding classBinding) {
49      this.classBinding = ObjectUtils.requireNonNull(classBinding, "classBinding");
50      this.configuration = new DefaultConfiguration<>();
51    }
52  
53    /**
54     * Retrieve the binding context associated with the serializer.
55     *
56     * @return the binding context
57     */
58    @NonNull
59    protected IBindingContext getBindingContext() {
60      return classBinding.getBindingContext();
61    }
62  
63    /**
64     * Retrieve the bound class information associated with the assembly that the
65     * serializer/deserializer will write/read data from.
66     *
67     * @return the class binding for the Module assembly
68     */
69    @NonNull
70    protected IAssemblyClassBinding getClassBinding() {
71      return classBinding;
72    }
73  
74    @SuppressWarnings("unused")
75    protected void configurationChanged(@NonNull IMutableConfiguration<T> config) {
76      // do nothing by default. Methods can override this to deal with factory caching
77    }
78  
79    /**
80     * Get the current configuration of the serializer/deserializer.
81     *
82     * @return the configuration
83     */
84    @NonNull
85    protected IMutableConfiguration<T> getConfiguration() {
86      return configuration;
87    }
88  
89    @Override
90    public boolean isFeatureEnabled(T feature) {
91      return configuration.isFeatureEnabled(feature);
92    }
93  
94    @Override
95    public Map<T, Object> getFeatureValues() {
96      return configuration.getFeatureValues();
97    }
98  
99    @Override
100   public <V> V get(T feature) {
101     return configuration.get(feature);
102   }
103 
104 }