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.codegen.typeinfo;
028
029import gov.nist.secauto.metaschema.core.model.IDefinition;
030import gov.nist.secauto.metaschema.core.model.INamedInstance;
031
032import java.util.Collection;
033
034import edu.umd.cs.findbugs.annotations.NonNull;
035import edu.umd.cs.findbugs.annotations.Nullable;
036
037public interface IDefinitionTypeInfo {
038  /**
039   * Get the definition associated with this type info.
040   *
041   * @return the definition
042   */
043  @NonNull
044  IDefinition getDefinition();
045
046  /**
047   * Gets the resolver which can be used to lookup Java type information for
048   * Module objects.
049   *
050   * @return the type resolver
051   */
052  @NonNull
053  ITypeResolver getTypeResolver();
054
055  /**
056   * Check's if the Java class to be generated will have a property with the given
057   * name.
058   *
059   * @param propertyName
060   *          the property name to look for
061   * @return {@code true} if there is an associated property with the name or
062   *         {@code false} otherwise
063   */
064  boolean hasPropertyWithName(@NonNull String propertyName);
065
066  /**
067   * Get the type information for the provided {@code instance} value.
068   *
069   * @param instance
070   *          the instance to get type information for
071   * @return the type information
072   */
073  @Nullable
074  IInstanceTypeInfo getInstanceTypeInfo(@NonNull INamedInstance instance);
075
076  /**
077   * Get the type information for all instance values on this definition.
078   *
079   * @return the type information
080   */
081  @NonNull
082  Collection<IInstanceTypeInfo> getInstanceTypeInfos();
083
084  /**
085   * Get the type information for all Java class properties associated with a
086   * given instance.
087   *
088   * @return the type information
089   */
090  @NonNull
091  Collection<ITypeInfo> getPropertyTypeInfos();
092}