Class TypeDefSummary

  • All Implemented Interfaces:
    Serializable
    Direct Known Subclasses:
    TypeDef

    public class TypeDefSummary
    extends TypeDefLink
    The TypeDefSummary holds basic identifying information for a specific TypeDef. It is used in the registration process between repositories.
    See Also:
    Serialized Form
    • Field Detail

      • version

        protected long version
      • versionName

        protected String versionName
    • Constructor Detail

      • TypeDefSummary

        public TypeDefSummary()
        Default constructor
      • TypeDefSummary

        public TypeDefSummary​(TypeDefSummary template)
        Copy/clone constructor copies the values from the supplied template.
        Parameters:
        template - TypeDefSummary
    • Method Detail

      • getCategory

        public TypeDefCategory getCategory()
        Return the category of the TypeDef.
        Returns:
        TypeDefCategory enum
      • setCategory

        public void setCategory​(TypeDefCategory category)
        Set up the category of the TypeDef.
        Parameters:
        category - TypeDefCategory enum
      • getVersion

        public long getVersion()
        Return the version of the TypeDef. Versions are created when a TypeDef's properties are changed. If a description is updated, then this does not create a new version.
        Returns:
        String version number
      • setVersion

        public void setVersion​(long version)
        Set up the version of the TypeDef. Versions are created when a TypeDef's properties are changed. If a description is updated, then this does not create a new version.
        Parameters:
        version - long version number
      • getVersionName

        public String getVersionName()
        Return the version name is more of a human readable form of the version number. It can be used to show whether the change is a minor or major update.
        Returns:
        String version name
      • setVersionName

        public void setVersionName​(String versionName)
        Set up the version name is more of a human readable form of the version number. It can be used to show whether the change is a minor or major update.
        Parameters:
        versionName - String version name
      • toString

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

        public boolean equals​(Object objectToCompare)
        Validate that an object is equal depending on their stored values.
        Overrides:
        equals in class TypeDefLink
        Parameters:
        objectToCompare - object
        Returns:
        boolean result
      • hashCode

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