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.model; 028 029import gov.nist.secauto.metaschema.core.model.IFeatureFlagContainer; 030import gov.nist.secauto.metaschema.databind.IBindingContext; 031import gov.nist.secauto.metaschema.databind.io.BindingException; 032 033import edu.umd.cs.findbugs.annotations.NonNull; 034import edu.umd.cs.findbugs.annotations.Nullable; 035 036public interface IClassBinding extends IFeatureFlagContainer<IBoundFlagInstance> { 037 @NonNull 038 IBindingContext getBindingContext(); 039 040 @NonNull 041 <CLASS> CLASS newInstance() throws BindingException; 042 043 /** 044 * The class this binding is for. 045 * 046 * @return the bound class 047 */ 048 @NonNull 049 Class<?> getBoundClass(); 050 051 void callBeforeDeserialize( 052 @NonNull Object targetObject, 053 @Nullable Object parentObject) throws BindingException; 054 055 void callAfterDeserialize( 056 @NonNull Object targetObject, 057 @Nullable Object parentObject) throws BindingException; 058 059 /** 060 * Create a deep copy of the provided bound object. 061 * 062 * @param item 063 * the bound object to copy 064 * @param parentInstance 065 * the new object's parent instance or {@code null} 066 * @return the copy 067 * @throws BindingException 068 * if an error occurred copying content between java instances 069 */ 070 @NonNull 071 Object copyBoundObject(@NonNull Object item, Object parentInstance) throws BindingException; 072}