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 com.squareup.javapoet.TypeName;
030
031import edu.umd.cs.findbugs.annotations.NonNull;
032
033public interface ITypeInfo {
034
035  /**
036   * Get the name to use for the property. If the property is a collection type,
037   * then this will be the group-as name, else this will be the use name or the
038   * name if not use name is set.
039   *
040   * @return the name
041   */
042  @NonNull
043  String getBaseName();
044
045  /**
046   * The name to use for Java constructs that refer to the item. This is used for
047   * when a field is collection-based and there is a need to refer to a single
048   * item, such as in an add/remove method name.
049   *
050   * @return the item base name
051   */
052  @NonNull
053  default String getItemBaseName() {
054    return getBaseName();
055  }
056
057  /**
058   * Get the Java property name for the property.
059   *
060   * @return the Java property name
061   */
062  @NonNull
063  String getPropertyName();
064
065  /**
066   * Gets the name of the Java field for this property.
067   *
068   * @return the Java field name
069   */
070  @NonNull
071  String getJavaFieldName();
072
073  /**
074   * Gets the type of the associated Java field for the property.
075   *
076   * @return the Java type for the field
077   */
078  @NonNull
079  TypeName getJavaFieldType();
080
081  /**
082   * Gets the type of the property's item.
083   *
084   * @return the Java type for the item
085   */
086  @NonNull
087  default TypeName getJavaItemType() {
088    return getJavaFieldType();
089  }
090}