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.model;
28
29 import gov.nist.secauto.metaschema.core.model.IFeatureFlagContainer;
30 import gov.nist.secauto.metaschema.databind.IBindingContext;
31 import gov.nist.secauto.metaschema.databind.io.BindingException;
32
33 import edu.umd.cs.findbugs.annotations.NonNull;
34 import edu.umd.cs.findbugs.annotations.Nullable;
35
36 public interface IClassBinding extends IFeatureFlagContainer<IBoundFlagInstance> {
37 @NonNull
38 IBindingContext getBindingContext();
39
40 @NonNull
41 <CLASS> CLASS newInstance() throws BindingException;
42
43 /**
44 * The class this binding is for.
45 *
46 * @return the bound class
47 */
48 @NonNull
49 Class<?> getBoundClass();
50
51 void callBeforeDeserialize(
52 @NonNull Object targetObject,
53 @Nullable Object parentObject) throws BindingException;
54
55 void callAfterDeserialize(
56 @NonNull Object targetObject,
57 @Nullable Object parentObject) throws BindingException;
58
59 /**
60 * Create a deep copy of the provided bound object.
61 *
62 * @param item
63 * the bound object to copy
64 * @param parentInstance
65 * the new object's parent instance or {@code null}
66 * @return the copy
67 * @throws BindingException
68 * if an error occurred copying content between java instances
69 */
70 @NonNull
71 Object copyBoundObject(@NonNull Object item, Object parentInstance) throws BindingException;
72 }