Package org.cakelab.blender.doc
Class StructDoc
- java.lang.Object
-
- java.util.AbstractMap<K,V>
-
- java.util.HashMap<java.lang.String,java.lang.Object>
-
- org.cakelab.json.JSONObject
-
- org.cakelab.blender.doc.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 Summary
Constructors Constructor Description StructDoc()
StructDoc(java.io.File origin)
StructDoc(JSONObject doc, java.io.File origin)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
addFields(JSONObject basefields)
add all non-existing fieldsboolean
containsNewInformation(StructDoc structDoc)
Determines whether given StructDoc provides more documentation than already captured in this StructDoc.boolean
containsOrigin(java.io.File origin)
boolean
inherit(StructDoc base)
only inherit documentation of member variables, which are yet without documentation.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.boolean
overrideFields(JSONObject overriding)
add non-existing and replace existing fields-
Methods inherited from class org.cakelab.json.JSONObject
getArray, getArray, getBoolean, getBoolean, getDouble, getDouble, getLong, getLong, getObject, getObject, getString, getString, toString, toString
-
Methods inherited from class java.util.HashMap
clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.cakelab.json.JSONCompoundType
arrayvalue, arrayvalue, booleanvalue, booleanvalue, defaultvalue, doublevalue, doublevalue, longvalue, longvalue, objectvalue, objectvalue, stringvalue, stringvalue
-
-
-
-
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
-
-