public abstract static class GenericLinkedView.StructureType extends Object
Modifier and Type | Field and Description |
---|---|
String |
arrayElementExpression
Expression for array element in array display, or an empty string if
there is no such display.
|
String |
arrayFieldName
Name of field holding array in array display, if applicable, an empty
string otherwise.
|
String |
arraySizeExpression
Expression for array size in array display, or an empty string if
there is no such display.
|
List<String> |
displayFields
Display fields.
|
boolean |
fieldsMod
True if fields in this structure were chosen by the user, false
otherwise.
|
String |
nodeTypeName
Type name of nodes.
|
boolean |
userCreated
True if this structure type was created by the user, false
otherwise.
|
String |
wrapperExpression
If non-empty, the target class is a wrapper, and this expression
provides the first node (head node in a list, root node in a tree,
etc.).
|
Constructor and Description |
---|
StructureType()
Creates a new StructureType.
|
StructureType(String wrapperExpressionIn,
List<String> displayFieldsIn)
Creates a new StructureType.
|
Modifier and Type | Method and Description |
---|---|
abstract GenericLinkedView.StructureType |
copy()
Makes a copy.
|
void |
copyRootFields(GenericLinkedView.StructureType st)
Copies the structure properties of another StructureType.
|
abstract GenericLinkedView.StructureType |
createFromSettings()
Creates a new StructureType initialized using the entries in the
settings panel.
|
abstract PresentationView<?> |
createViewer(ViewerCreateData vcd,
Type type,
DebugContext context)
Creates a viewer for this structure type.
|
boolean |
displayFieldsChanged()
Determines if display fields have changed.
|
boolean |
equals(Object o)
Indicates whether some other object is "equal to" this one.
|
void |
fieldsXML(Document doc,
Element e)
Populates an XML dom element with fields data for this structure
type.
|
protected abstract String |
getCurrentArrayField()
Gets the current value of the array entry field.
|
abstract String |
getCurrentWrapperField()
Gets the "live" wrapper field in the configuration dialog.
|
abstract String |
getFullDescription()
Gets a long description for this structure type.
|
protected String |
getNodeTypeName(Type type,
DebugContext context)
Gets the type name for structure nodes.
|
abstract JPanel |
getSettingsPanel()
Gets a panel that allows the settings in the current subclass of
StructureType to be set.
|
abstract String |
getWrapperField()
Gets the wrapper field.
|
int |
hashCode()
Returns a hash code value for the object.
|
void |
init(Element e)
Initializes the structure.
|
void |
initFields(Element dispFieldsE)
Initializes fields from XML data.
|
boolean |
isPossibleSub(GenericLinkedView.StructureType st)
Determines if this structure might be a component structure of
another.
|
void |
setWrapperExpression(String wrapperExpressionIn) |
void |
toXML(Document doc,
Element e)
Populates an XML dom element for this structure type.
|
public String arrayElementExpression
public String arraySizeExpression
public String arrayFieldName
public String wrapperExpression
public String nodeTypeName
public boolean userCreated
public boolean fieldsMod
public StructureType()
public StructureType(String wrapperExpressionIn, List<String> displayFieldsIn)
wrapperExpressionIn
- if non-empty, the target class is a
wrapper, and this expression provides the first node (head node in a
list, root node in a tree, etc.).displayFieldsIn
- names of fields to display. This may not be
null.public abstract GenericLinkedView.StructureType copy()
public void copyRootFields(GenericLinkedView.StructureType st)
st
- the source of the copy data.public abstract GenericLinkedView.StructureType createFromSettings()
public abstract PresentationView<?> createViewer(ViewerCreateData vcd, Type type, DebugContext context)
vcd
- creation data.type
- the target type.context
- current debugger context.public boolean displayFieldsChanged()
public boolean equals(Object o)
The equals
method implements an equivalence relation
on non-null object references:
x
, x.equals(x)
should return
true
.
x
and y
, x.equals(y)
should return true
if and only if
y.equals(x)
returns true
.
x
, y
, and z
, if
x.equals(y)
returns true
and
y.equals(z)
returns true
, then
x.equals(z)
should return true
.
x
and y
, multiple invocations of
x.equals(y)
consistently return true
or consistently return false
, provided no
information used in equals
comparisons on the
objects is modified.
x
,
x.equals(null)
should return false
.
The equals
method for class Object
implements
the most discriminating possible equivalence relation on objects;
that is, for any non-null reference values x
and
y
, this method returns true
if and only
if x
and y
refer to the same object
(x == y
has the value true
).
Note that it is generally necessary to override the hashCode
method whenever this method is overridden, so as to maintain the
general contract for the hashCode
method, which states
that equal objects must have equal hash codes.
equals
in class Object
o
- the reference object with which to compare.true
if this object is the same as the obj
argument; false
otherwise.Object.hashCode()
,
HashMap
public void fieldsXML(Document doc, Element e)
doc
- the document to which the element applies.e
- the element to be populated.public abstract String getCurrentWrapperField()
public abstract String getFullDescription()
public abstract JPanel getSettingsPanel()
public abstract String getWrapperField()
public int hashCode()
java.lang.Object
HashMap
.
The general contract of hashCode
is:
hashCode
method
must consistently return the same integer, provided no information
used in equals
comparisons on the object is modified.
This integer need not remain consistent from one execution of an
application to another execution of the same application.
equals(Object)
method, then calling the hashCode
method on each of
the two objects must produce the same integer result.
Object.equals(java.lang.Object)
method, then calling the hashCode
method on each of the
two objects must produce distinct integer results. However, the
programmer should be aware that producing distinct integer results
for unequal objects may improve the performance of hash tables.
As much as is reasonably practical, the hashCode method defined by
class Object
does return distinct integers for distinct
objects. (This is typically implemented by converting the internal
address of the object into an integer, but this implementation
technique is not required by the
Java™ programming language.)
hashCode
in class Object
Object.equals(java.lang.Object)
,
System.identityHashCode(java.lang.Object)
public void init(Element e) throws grasp.util.XMLUtil.Err
e
- the initialization data.XMLUtil.Err
- if there is an error in parsing the data.public void initFields(Element dispFieldsE) throws grasp.util.XMLUtil.Err
dispFieldsE
- the XML fields element.XMLUtil.Err
- if there is an error in parsing the data.public boolean isPossibleSub(GenericLinkedView.StructureType st)
st
- possible parent structure.st
, false otherwise. The default implementation always
returns false.public void setWrapperExpression(String wrapperExpressionIn)
public void toXML(Document doc, Element e)
doc
- the document to which the element applies.e
- the element to be populated.protected abstract String getCurrentArrayField()
protected String getNodeTypeName(Type type, DebugContext context)
type
- the type of the structure.context
- the current debugger context.