ITypeResolver.java

/*
 * Portions of this software was developed by employees of the National Institute
 * of Standards and Technology (NIST), an agency of the Federal Government and is
 * being made available as a public service. Pursuant to title 17 United States
 * Code Section 105, works of NIST employees are not subject to copyright
 * protection in the United States. This software may be subject to foreign
 * copyright. Permission in the United States and in foreign countries, to the
 * extent that NIST may hold copyright, to use, copy, modify, create derivative
 * works, and distribute this software and its documentation without fee is hereby
 * granted on a non-exclusive basis, provided that this notice and disclaimer
 * of warranty appears in all copies.
 *
 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE.  IN NO EVENT
 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
 */

package gov.nist.secauto.metaschema.databind.codegen.typeinfo;

import com.squareup.javapoet.ClassName;

import gov.nist.secauto.metaschema.core.model.IAssemblyDefinition;
import gov.nist.secauto.metaschema.core.model.IFieldDefinition;
import gov.nist.secauto.metaschema.core.model.IFlagContainer;
import gov.nist.secauto.metaschema.core.model.IModule;
import gov.nist.secauto.metaschema.databind.codegen.config.IBindingConfiguration;

import edu.umd.cs.findbugs.annotations.NonNull;
import edu.umd.cs.findbugs.annotations.Nullable;

public interface ITypeResolver {
  /**
   * Construct a new type resolver using the default implementation.
   *
   * @param bindingConfiguration
   *          the binding configuration used to configure types
   * @return the type resolver
   */
  @NonNull
  static ITypeResolver newTypeResolver(@NonNull IBindingConfiguration bindingConfiguration) {
    return new DefaultTypeResolver(bindingConfiguration);
  }

  /**
   * Get type information for the provided {@code definition}.
   *
   * @param definition
   *          the definition to get type information for
   * @return the type information
   */
  @NonNull
  IAssemblyDefinitionTypeInfo getTypeInfo(@NonNull IAssemblyDefinition definition);

  /**
   * Get type information for the provided {@code definition}.
   *
   * @param definition
   *          the definition to get type information for
   * @return the type information
   */
  @NonNull
  IFieldDefinitionTypeInfo getTypeInfo(@NonNull IFieldDefinition definition);

  /**
   * Get type information for the provided {@code definition}.
   *
   * @param definition
   *          the definition to get type information for
   * @return the type information
   */
  @NonNull
  IModelDefinitionTypeInfo getTypeInfo(@NonNull IFlagContainer definition);

  /**
   * Get the name of the class associated with the provided Module module.
   *
   * @param module
   *          the Module module that will be built as a class
   * @return the class name information for the Module module
   */
  @NonNull
  ClassName getClassName(@NonNull IModule module);

  /**
   * Get the name of the class associated with the provided definition.
   *
   * @param definition
   *          a definition that may be built as a subclass
   * @return the class name information for the definition
   */
  @NonNull
  ClassName getClassName(@NonNull IFlagContainer definition);

  /**
   * Get the name of the base class to use for the class associated with the
   * provided definition.
   *
   * @param definition
   *          a definition that may be built as a class
   * @return the name of the base class or {@code null} if no base class is to be
   *         used
   */
  @Nullable
  ClassName getBaseClassName(@NonNull IFlagContainer definition);

  /**
   * Get the Java package name to use for the provided Module module.
   *
   * @param module
   *          the Module module
   * @return the Java package name
   */
  @NonNull
  String getPackageName(@NonNull IModule module);
}