All Implemented Interfaces:
Serializable

public class InstanceType extends InstanceElementHeader
InstanceType contains information from the instance's TypeDef that are useful for processing the instance.
See Also:
  • Field Details

    • CURRENT_INSTANCE_TYPE_HEADER_VERSION

      public static final long CURRENT_INSTANCE_TYPE_HEADER_VERSION
      Version of the header used in this release
      See Also:
  • Constructor Details

    • InstanceType

      public InstanceType()
      Default constructor relies on initialization of variables in the declaration.
    • InstanceType

      public InstanceType(TypeDefCategory typeDefCategory, String typeDefGUID, String typeDefName, long typeDefVersion)
      Typical constructor that set all the properties at once.
      Parameters:
      typeDefCategory - the category of the type
      typeDefGUID - unique identifier of the type
      typeDefName - unique name of the type
      typeDefVersion - version number of the type
    • InstanceType

      public InstanceType(InstanceType template)
      Copy/clone constructor
      Parameters:
      template - instance type to copy
  • Method Details

    • getTypeDefCategory

      public TypeDefCategory getTypeDefCategory()
      Return the category of this instance. This defines the category of the TypeDef that determines its properties.
      Returns:
      TypeDefCategory enum
    • setTypeDefCategory

      public void setTypeDefCategory(TypeDefCategory typeDefCategory)
      Set up the category of this instance. This defines the category of the TypeDef that determines its properties.
      Parameters:
      typeDefCategory - enum
    • getTypeDefGUID

      public String getTypeDefGUID()
      Return the unique identifier for the type of this instance.
      Returns:
      String unique identifier
    • setTypeDefGUID

      public void setTypeDefGUID(String typeDefGUID)
      Set up the unique identifier for the type of this instance.
      Parameters:
      typeDefGUID - String unique identifier
    • getTypeDefName

      public String getTypeDefName()
      Return the name of this instance's type.
      Returns:
      String type name
    • setTypeDefName

      public void setTypeDefName(String typeDefName)
      Set up the name of this instance's type.
      Parameters:
      typeDefName - String type name
    • getTypeDefVersion

      public long getTypeDefVersion()
      Return the version number of this instance's TypeDef.
      Returns:
      long version number
    • setTypeDefVersion

      public void setTypeDefVersion(long typeDefVersion)
      Set up the version for the TypeDef.
      Parameters:
      typeDefVersion - long version number
    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class Object
      Returns:
      JSON style description of variables.
    • equals

      public boolean equals(Object objectToCompare)
      Validate if the supplied object equals this object.
      Overrides:
      equals in class RepositoryElementHeader
      Parameters:
      objectToCompare - test object
      Returns:
      boolean evaluation
    • hashCode

      public int hashCode()
      Return a hash code based on the values of this object.
      Overrides:
      hashCode in class RepositoryElementHeader
      Returns:
      in hash code