Package org.opendaylight.yangtools.binding.model.api

Interface GeneratedTransferObject

All Superinterfaces:
DocumentedType, GeneratedType, Identifiable<JavaTypeName>, Type
All Known Subinterfaces:
RuntimeGeneratedUnion
All Known Implementing Classes:
RuntimeGeneratedTOBuilder.GTO
public interface GeneratedTransferObject extends GeneratedType
Generated Transfer Object extends GeneratedType and is designed to represent Java Class. The Generated Transfer Object contains declarations of member fields stored in List of Properties. The Generated Transfer Object can be extended by exactly ONE Generated Transfer Object as Java does not allow multiple inheritance. For retrieval of implementing Generated Types use GeneratedType.getImplements() method.
Every transfer object SHOULD contain equals, hashCode and toString definitions. For this purpose retrieve definitions through (), getHashCodeIdentifiers() and getToStringIdentifiers().

  • Method Details

    • getSUID

      GeneratedProperty getSUID()

    • getSuperType

      GeneratedTransferObject getSuperType()
      Returns the Generated Transfer Object from which this GTO is derived, or null if this GTO is not derived from a GTO -- e.g. it is either an union or it is derived from a concrete type.
      Returns:
      Generated Transfer Object or null if this GTO is not derived from another GTO.

    • getEqualsIdentifiers

      List<GeneratedProperty> getEqualsIdentifiers()
      Returns List of Properties that are designated to define equality for Generated Transfer Object.
      Returns:
      List of Properties that are designated to define equality for Generated Transfer Object.

    • getHashCodeIdentifiers

      List<GeneratedProperty> getHashCodeIdentifiers()
      Returns List of Properties that are designated to define identity for Generated Transfer Object.
      Returns:
      List of Properties that are designated to define identity for Generated Transfer Object.

    • getToStringIdentifiers

      List<GeneratedProperty> getToStringIdentifiers()
      Returns List of Properties that will be members of toString definition for Generated Transfer Object.
      Returns:
      List of Properties that will be members of toString definition for Generated Transfer Object.

    • isTypedef

      boolean isTypedef()

    • getBaseType

      TypeDefinition<?> getBaseType()
      Returns Base type of Java representation of YANG typedef if set, otherwise it returns null.
      Returns:
      Base type of Java representation of YANG typedef if set, otherwise it returns null

    • isUnionType

      boolean isUnionType()
      Return boolean value which describe whether Generated Transfer Object was created (or not) from union YANG type.
      Returns:
      true value if Generated Transfer Object was created from union YANG type.

    • getRestrictions

      Restrictions getRestrictions()

    • findProperty

      default Optional<? extends GeneratedProperty> findProperty(String name)