org.nlogo.api
Interface ExtensionObject

public interface ExtensionObject

Interface which all NetLogo objects defined in Extensions must support

Method Summary
 String dump(boolean readable, boolean exporting, boolean reference)
           
 String getExtensionName()
           
 String getNLTypeName()
           
 boolean recursivelyEqual(Object obj)
           
 

Method Detail

dump

String dump(boolean readable,
            boolean exporting,
            boolean reference)
Parameters:
readable - If true the result should be readable as NetLogo code
exporting - If false the result is for display only
reference - If true the result may be a reference to a complete object exported in the extension section of the file if false the object should be recreatable from the result
Returns:
a string representation of the object.

getExtensionName

String getExtensionName()
Returns:
the name of the extension this object was created by

getNLTypeName

String getNLTypeName()
Returns:
the type of this Object, which is extension defined. If this is the only ExtensionObject type defined by this extension it is appropriate to return an empty string.

recursivelyEqual

boolean recursivelyEqual(Object obj)
Returns:
true if this object equal to obj not simply the same object but all of the elements are the same