/*
* JavaInspect - Utility to visualize java software
- * Copyright (C) 2013, Svjatoslav Agejenko, svjatoslav@svjatoslav.eu
- *
+ * Copyright (C) 2013-2015, Svjatoslav Agejenko, svjatoslav@svjatoslav.eu
+ *
* This program is free software; you can redistribute it and/or
- * modify it under the terms of version 2 of the GNU General Public License
- * as published by the Free Software Foundation.
+ * modify it under the terms of version 3 of the GNU Lesser General Public License
+ * or later as published by the Free Software Foundation.
*/
package eu.svjatoslav.inspector.java.structure;
private static final int MAX_REFERECNES_COUNT = 10;
- public final String fullyQualifiedName;
+ public String classFullyQualifiedName;
- Map<String, FieldDescriptor> nameToFieldMap = new TreeMap<String, FieldDescriptor>();
+ private final Map<String, FieldDescriptor> nameToFieldMap = new TreeMap<String, FieldDescriptor>();
- public SortedSet<MethodDescriptor> methods = new TreeSet<MethodDescriptor>();
+ private final SortedSet<MethodDescriptor> methods = new TreeSet<MethodDescriptor>();
/**
* Incoming arrows will have this color.
/**
* Amount of field and method references pointing to this class.
*/
- private int incomingReferencesCount = 0;
+ private int referencesCount = 0;
+ // for interface, counts amount of found implementations
+ private int implementationsCount = 0;
+
+ // counts amount of times this class is extended
private int extensionsCount = 0;
- public ClassDescriptor(final Class<? extends Object> clazz,
- final ClassGraph dump) {
- classGraph = dump;
+ private ClassDescriptor arrayComponent;
+
+ public ClassDescriptor(final ClassGraph classGraph) {
+ this.classGraph = classGraph;
+ }
- fullyQualifiedName = clazz.getName();
- dump.nameToClassMap.put(fullyQualifiedName, this);
+ public void analyzeClass(final Class<? extends Object> clazz) {
+
+ classFullyQualifiedName = clazz.getName();
isArray = clazz.isArray();
if (isArray) {
final Class<?> componentType = clazz.getComponentType();
- dump.addClass(componentType);
+ arrayComponent = getClassGraph().getOrCreateClassDescriptor(
+ componentType);
}
// System.out.println("class: " + fullyQualifiedName);
indexMethods(clazz);
for (final Class interfaceClass : clazz.getInterfaces()) {
- final ClassDescriptor classDescriptor = dump
- .addClass(interfaceClass);
- classDescriptor.registerExtension();
- interfaces.add(classDescriptor);
+ final ClassDescriptor interfaceClassDescriptor = getClassGraph()
+ .getOrCreateClassDescriptor(interfaceClass);
+ interfaceClassDescriptor.registerImplementation();
+ interfaces.add(interfaceClassDescriptor);
}
- superClass = dump.addClass(clazz.getSuperclass());
+ superClass = getClassGraph().getOrCreateClassDescriptor(
+ clazz.getSuperclass());
if (superClass != null)
superClass.registerExtension();
- }
+ };
public boolean areReferencesShown() {
- return incomingReferencesCount <= MAX_REFERECNES_COUNT;
+ return referencesCount <= MAX_REFERECNES_COUNT;
}
public void enlistFieldReferences(final StringBuffer result) {
result.append("\n");
result.append(" // interfaces implemented by class: "
- + fullyQualifiedName + "\n");
+ + classFullyQualifiedName + "\n");
for (final ClassDescriptor interfaceDescriptor : interfaces) {
if (!interfaceDescriptor.isVisible())
continue;
+ if (!interfaceDescriptor.areReferencesShown())
+ continue;
+
result.append(" " + interfaceDescriptor.getGraphId() + " -> "
- + getGraphId() + "[style=\"dotted, tapered\", color=\""
+ + getGraphId() + "[style=\"dotted\", color=\""
+ interfaceDescriptor.getInterfaceColor()
- + "\", penwidth=20, dir=\"forward\"];\n");
+ + "\", penwidth=10, dir=\"forward\"];\n");
}
}
if (!superClass.isVisible())
return;
+ if (!superClass.areReferencesShown())
+ return;
+
result.append("\n");
- result.append(" // super class for: " + fullyQualifiedName + "\n");
+ result.append(" // super class for: " + classFullyQualifiedName
+ + "\n");
result.append(" " + superClass.getGraphId() + " -> " + getGraphId()
- + "[style=\"tapered\", color=\""
- + superClass.getSuperClassColor()
+ + "[ color=\"" + superClass.getSuperClassColor()
+ "\", penwidth=10, dir=\"forward\"];\n");
}
public void generateDotHeader(final StringBuffer result) {
result.append("\n");
- result.append("// Class: " + fullyQualifiedName + "\n");
+ result.append("// Class: " + classFullyQualifiedName + "\n");
result.append(" " + getGraphId() + "[label=<<TABLE "
+ getBackgroundColor() + " BORDER=\"" + getBorderWidth()
return "1";
}
+ public ClassGraph getClassGraph() {
+ return classGraph;
+ }
+
public String getClassName(final boolean differentiateArray) {
// this is needed for nested classes
- final String actualClassName = fullyQualifiedName.replace('$', '.');
-
- final int i = actualClassName.lastIndexOf('.');
-
- String result = actualClassName.substring(i + 1);
+ final String actualClassName = classFullyQualifiedName
+ .replace('$', '.');
- if (isArray)
- result = result.substring(0, result.length() - 1);
+ String result;
+ if (isArray) {
+ // for arrays use array component instead of array class name
+ result = arrayComponent.classFullyQualifiedName;
+ if (result.contains(".")) {
+ final int i = result.lastIndexOf('.');
+ result = result.substring(i + 1);
+ }
+ } else {
+ final int i = actualClassName.lastIndexOf('.');
+ result = actualClassName.substring(i + 1);
+ }
if (differentiateArray)
if (isArray)
return null;
}
+ /**
+ * Returns field with given name (case is ignored). Or <code>null</code> if
+ * field is not found.
+ */
+ public FieldDescriptor getFieldIgnoreCase(final String fieldToSearch) {
+
+ for (final String fieldName : nameToFieldMap.keySet())
+ if (fieldToSearch.equalsIgnoreCase(fieldName))
+ return nameToFieldMap.get(fieldName);
+
+ return null;
+ }
+
@Override
public String getGraphId() {
final String result = "class_"
- + fullyQualifiedName.replace('.', '_').replace(";", "")
+ + classFullyQualifiedName.replace('.', '_').replace(";", "")
.replace("[L", "").replace('$', '_');
return result;
}
public String getInterfaceColor() {
if (interfaceColor == null)
- interfaceColor = Utils.getNextLightColor();
+ interfaceColor = Utils.getNextDarkColor();
return interfaceColor;
}
+ // public String getReadableName() {
+ //
+ // // do not print full class name for well known system classes
+ // final String packageName = getPackageName();
+ //
+ // if (packageName.equals("java.util"))
+ // return getClassName();
+ //
+ // if (packageName.equals("java.lang"))
+ // return getClassName();
+ //
+ // return fullyQualifiedName;
+ // }
+
+ private FieldDescriptor getOrCreateFieldDescriptor(final Field field) {
+
+ final String fieldName = field.getName();
+
+ if (nameToFieldMap.containsKey(fieldName))
+ return nameToFieldMap.get(fieldName);
+
+ final FieldDescriptor newFieldDescriptor = new FieldDescriptor(this);
+ nameToFieldMap.put(fieldName, newFieldDescriptor);
+
+ newFieldDescriptor.analyzeField(field);
+
+ return newFieldDescriptor;
+ }
+
private int getOutgoingReferencesCount() {
int result = 0;
public String getPackageName() {
- final int i = fullyQualifiedName.lastIndexOf('.');
+ final int i = classFullyQualifiedName.lastIndexOf('.');
if (i == -1)
return "";
- return fullyQualifiedName.substring(0, i).replace("[L", "");
+ return classFullyQualifiedName.substring(0, i).replace("[L", "");
}
- // public String getReadableName() {
- //
- // // do not print full class name for well known system classes
- // final String packageName = getPackageName();
- //
- // if (packageName.equals("java.util"))
- // return getClassName();
- //
- // if (packageName.equals("java.lang"))
- // return getClassName();
- //
- // return fullyQualifiedName;
- // }
-
public String getParentClassesName() {
- int i = fullyQualifiedName.lastIndexOf('.');
- final String fullClassName = fullyQualifiedName.substring(i + 1);
+ int i = classFullyQualifiedName.lastIndexOf('.');
+ final String fullClassName = classFullyQualifiedName.substring(i + 1);
i = fullClassName.lastIndexOf('$');
if (i == -1)
return superClassColor;
}
+ /**
+ * Checks if class has field with given name (case is ignored). Returns
+ * <code>true</code> if such field is found.
+ */
+ public boolean hasFieldIgnoreCase(final String fieldToSearch) {
+
+ for (final String fieldName : nameToFieldMap.keySet())
+ if (fieldToSearch.equalsIgnoreCase(fieldName))
+ return true;
+
+ return false;
+ }
+
public void hide() {
isShown = false;
}
return;
final int totalReferencesCount = getOutgoingReferencesCount()
- + incomingReferencesCount + extensionsCount;
+ + referencesCount + extensionsCount + implementationsCount;
if (totalReferencesCount == 0) {
hide();
}
public void indexFields(final Field[] fields) {
- for (final Field field : fields) {
- if (nameToFieldMap.containsKey(field.getName()))
- continue;
-
- final FieldDescriptor fieldDescriptor = new FieldDescriptor(field,
- this, classGraph);
-
- }
+ for (final Field field : fields)
+ getOrCreateFieldDescriptor(field);
}
private void indexMethods(final Class<? extends Object> clazz) {
- final Method[] methods = clazz.getMethods();
+ for (final Method method : clazz.getMethods()) {
+ final MethodDescriptor methodDescriptor = new MethodDescriptor(
+ this, method.getName());
- for (final Method method : methods)
- new MethodDescriptor(method, this, classGraph);
+ methods.add(methodDescriptor);
+
+ methodDescriptor.analyze(method);
+ }
}
@Override
public boolean isVisible() {
- if (Utils.isSystemDataType(fullyQualifiedName))
+ if (Utils.isSystemDataType(classFullyQualifiedName))
return false;
- if (Utils.isSystemPackage(fullyQualifiedName))
+ if (Utils.isSystemPackage(classFullyQualifiedName))
return false;
- if (!classGraph.getFilter().isClassShown(fullyQualifiedName))
+ if (!getClassGraph().getFilter().isClassShown(classFullyQualifiedName))
return false;
+ if (isArray)
+ if (arrayComponent != null)
+ if (Utils
+ .isSystemDataType(arrayComponent.classFullyQualifiedName))
+ // Do not show references to primitive data types in arrays.
+ // That is: there is no point to show reference to byte when
+ // we have class with byte array field.
+ return false;
+
return isShown;
}
/**
- * Register event when another class is extending this one, or is
- * implementing interface declared by this class.
+ * Register event when another class is extending this one.
*/
public void registerExtension() {
extensionsCount++;
}
+ public void registerImplementation() {
+ implementationsCount++;
+ }
+
public void registerReference() {
- incomingReferencesCount++;
+ referencesCount++;
}
public void setDistinctiveColor(final String distinctiveColor) {