Class ExternalReferenceElement

  • All Implemented Interfaces:
    java.io.Serializable, MetadataElement

    public class ExternalReferenceElement
    extends java.lang.Object
    implements MetadataElement, java.io.Serializable
    ExternalReferenceElement stores information about an link to an external resource that is relevant to this element.
    See Also:
    Serialized Form
    • Constructor Detail

      • ExternalReferenceElement

        public ExternalReferenceElement()
        Default Constructor
      • ExternalReferenceElement

        public ExternalReferenceElement​(ExternalReferenceElement template)
        Copy/clone Constructor - the resulting object.
        Parameters:
        template - object being copied
    • Method Detail

      • setElementHeader

        public void setElementHeader​(ElementHeader elementHeader)
        Set up the element header associated with the properties.
        Specified by:
        setElementHeader in interface MetadataElement
        Parameters:
        elementHeader - element header object
      • getProperties

        public ExternalReferenceProperties getProperties()
        Return the link to external documentation that are relevant to this element.
        Returns:
        list of external references
      • setProperties

        public void setProperties​(ExternalReferenceProperties properties)
        Set up the list of links to external documentation that are relevant to this element.
        Parameters:
        properties - of external references
      • toString

        public java.lang.String toString()
        JSON-style toString.
        Overrides:
        toString in class java.lang.Object
        Returns:
        list of properties and their values.
      • equals

        public boolean equals​(java.lang.Object objectToCompare)
        Equals method that returns true if containing properties are the same.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        objectToCompare - object to compare
        Returns:
        boolean result of comparison
      • hashCode

        public int hashCode()
        Hash of properties
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        int