IModelDefinitionTypeInfo.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.IFlagInstance;

import java.util.Collection;

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

public interface IModelDefinitionTypeInfo extends IDefinitionTypeInfo {
  /**
   * Construct a new type information object for the provided {@code definition}.
   *
   * @param definition
   *          the definition to provide type information for
   * @param typeResolver
   *          use to resolve type information for composite instances
   * @return the type information
   */
  @NonNull
  static IModelDefinitionTypeInfo newTypeInfo(
      @NonNull IFlagContainer definition,
      @NonNull ITypeResolver typeResolver) {
    IModelDefinitionTypeInfo retval;
    switch (definition.getModelType()) {
    case ASSEMBLY:
      retval = IAssemblyDefinitionTypeInfo.newTypeInfo((IAssemblyDefinition) definition, typeResolver);
      break;
    case FIELD:
      retval = IFieldDefinitionTypeInfo.newTypeInfo((IFieldDefinition) definition, typeResolver);
      break;
    default:
      throw new UnsupportedOperationException(
          String.format("Generation of child classes for %s definitions is unsupported",
              definition.getModelType().name()));
    }
    return retval;
  }

  @Override
  IFlagContainer getDefinition();

  /**
   * Get the class type information for the base class of the generated class, .
   *
   * @return the type information or {@code null} if no base class is configured
   */
  @Nullable
  ClassName getBaseClassName();

  /**
   * Gets the class type information for the object definition for which this
   * class is being generated.
   *
   * @return the class's type information
   */
  @NonNull
  ClassName getClassName();

  /**
   * Get the type information for the provided {@code instance} value.
   *
   * @param instance
   *          the instance to get type information for
   * @return the type information
   */
  @Nullable
  IFlagInstanceTypeInfo getFlagInstanceTypeInfo(@NonNull IFlagInstance instance);

  /**
   * Get the type information for all flag instance values on this definition.
   *
   * @return the type information
   */
  @NonNull
  Collection<IFlagInstanceTypeInfo> getFlagInstanceTypeInfos();
  //
  // /**
  // * Generates the associated Java class and saves it using the provided file.
  // *
  // * @param dir
  // * the directory to generate the class in
  // * @return the qualified class name for the generated class
  // * @throws IOException
  // * if a build error occurred while generating the class
  // */
  // @NonNull
  // IGeneratedDefinitionClass generateClass(@NonNull Path dir) throws
  // IOException;
  //
  // /**
  // * This method is responsible for generating the Java class using a builder
  // that
  // * is returned for further customization.
  // *
  // * @return the class definition for the generated class
  // * @throws IOException
  // * if a build error occurred while generating the class
  // */
  // @NonNull
  // TypeSpec generateChildClass() throws IOException;
}