Class StructDoc

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,​java.lang.Object>, JSONCompoundType

    public class StructDoc
    extends JSONObject
    See Also:
    Serialized Form
    • Constructor Detail

      • StructDoc

        public StructDoc​(JSONObject doc,
                         java.io.File origin)
      • StructDoc

        public StructDoc​(java.io.File origin)
      • StructDoc

        public StructDoc()
    • Method Detail

      • containsOrigin

        public boolean containsOrigin​(java.io.File origin)
      • containsNewInformation

        public boolean containsNewInformation​(StructDoc structDoc)
        Determines whether given StructDoc provides more documentation than already captured in this StructDoc.
      • inherit

        public boolean inherit​(StructDoc base)
        only inherit documentation of member variables, which are yet without documentation.
      • override

        public boolean override​(StructDoc overrides)
        override/replace all documentation entries from existing values of given structDoc overrides, but keep those documentation entries where no documentation was given with overrides.
      • addFields

        public boolean addFields​(JSONObject basefields)
        add all non-existing fields
      • overrideFields

        public boolean overrideFields​(JSONObject overriding)
        add non-existing and replace existing fields
        Returns:
        true, if modified