2 * JavaInspect - Utility to visualize java software
3 * Copyright (C) 2013-2014, Svjatoslav Agejenko, svjatoslav@svjatoslav.eu
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of version 3 of the GNU Lesser General Public License
7 * or later as published by the Free Software Foundation.
10 package eu.svjatoslav.inspector.java.structure;
12 import java.lang.reflect.Field;
13 import java.lang.reflect.Method;
14 import java.util.ArrayList;
15 import java.util.List;
17 import java.util.SortedSet;
18 import java.util.TreeMap;
19 import java.util.TreeSet;
22 * Describes single class instance
24 public class ClassDescriptor implements GraphElement {
26 private static final int MAX_REFERECNES_COUNT = 10;
28 public final String classFullyQualifiedName;
30 Map<String, FieldDescriptor> nameToFieldMap = new TreeMap<String, FieldDescriptor>();
32 public SortedSet<MethodDescriptor> methods = new TreeSet<MethodDescriptor>();
35 * Incoming arrows will have this color.
37 private String distinctiveReferenceColor;
39 private String interfaceColor;
41 private String superClassColor;
49 private boolean isShown = true;
51 private final ClassGraph classGraph;
53 List<ClassDescriptor> interfaces = new ArrayList<ClassDescriptor>();
55 ClassDescriptor superClass;
58 * Amount of field and method references pointing to this class.
60 private int referencesCount = 0;
62 // for interface, counts amount of found implementations
63 private int implementationsCount = 0;
65 // counts amount of times this class is extended
66 private int extensionsCount = 0;
68 private ClassDescriptor arrayComponent;
70 public ClassDescriptor(final Class<? extends Object> clazz,
71 final ClassGraph classGraph) {
72 this.classGraph = classGraph;
74 classFullyQualifiedName = clazz.getName();
76 classGraph.registerClass(classFullyQualifiedName, this);
78 isArray = clazz.isArray();
81 final Class<?> componentType = clazz.getComponentType();
82 arrayComponent = classGraph.addClass(componentType);
85 // System.out.println("class: " + fullyQualifiedName);
87 isEnum = clazz.isEnum();
89 isInterface = clazz.isInterface();
94 indexFields(clazz.getDeclaredFields());
95 indexFields(clazz.getFields());
99 for (final Class interfaceClass : clazz.getInterfaces()) {
100 final ClassDescriptor classDescriptor = classGraph
101 .addClass(interfaceClass);
102 classDescriptor.registerImplementation();
103 interfaces.add(classDescriptor);
106 superClass = classGraph.addClass(clazz.getSuperclass());
107 if (superClass != null)
108 superClass.registerExtension();
112 public boolean areReferencesShown() {
113 return referencesCount <= MAX_REFERECNES_COUNT;
116 public void enlistFieldReferences(final StringBuffer result) {
117 if (nameToFieldMap.isEmpty())
121 result.append(" // field references to other classes\n");
122 for (final Map.Entry<String, FieldDescriptor> entry : nameToFieldMap
124 result.append(entry.getValue().getDot());
127 public void enlistFields(final StringBuffer result) {
128 if (nameToFieldMap.isEmpty())
132 result.append(" // fields:\n");
135 for (final Map.Entry<String, FieldDescriptor> entry : nameToFieldMap
137 result.append(entry.getValue().getEmbeddedDot());
140 public void enlistImplementedInterfaces(final StringBuffer result) {
141 if (interfaces.isEmpty())
145 result.append(" // interfaces implemented by class: "
146 + classFullyQualifiedName + "\n");
148 for (final ClassDescriptor interfaceDescriptor : interfaces) {
149 if (!interfaceDescriptor.isVisible())
152 result.append(" " + interfaceDescriptor.getGraphId() + " -> "
153 + getGraphId() + "[style=\"dotted, tapered\", color=\""
154 + interfaceDescriptor.getInterfaceColor()
155 + "\", penwidth=20, dir=\"forward\"];\n");
159 public void enlistMethodReferences(final StringBuffer result) {
160 if (methods.isEmpty())
164 result.append(" // method references to other classes\n");
165 for (final MethodDescriptor methodDescriptor : methods)
166 result.append(methodDescriptor.getDot());
169 public void enlistMethods(final StringBuffer result) {
170 if (methods.isEmpty())
174 result.append(" // methods:\n");
177 for (final MethodDescriptor methodDescriptor : methods)
178 result.append(methodDescriptor.getEmbeddedDot());
181 public void enlistSuperClass(final StringBuffer result) {
182 if (superClass == null)
185 if (!superClass.isVisible())
189 result.append(" // super class for: " + classFullyQualifiedName
192 result.append(" " + superClass.getGraphId() + " -> " + getGraphId()
193 + "[style=\"tapered\", color=\""
194 + superClass.getSuperClassColor()
195 + "\", penwidth=10, dir=\"forward\"];\n");
198 public void generateDotHeader(final StringBuffer result) {
200 result.append("// Class: " + classFullyQualifiedName + "\n");
202 result.append(" " + getGraphId() + "[label=<<TABLE "
203 + getBackgroundColor() + " BORDER=\"" + getBorderWidth()
204 + "\" CELLBORDER=\"1\" CELLSPACING=\"0\">\n");
207 result.append(" // class descriptor header\n");
208 result.append(" <TR><TD colspan=\"2\" PORT=\"f0\">"
209 + "<FONT POINT-SIZE=\"8.0\" >" + getPackageName()
212 final String parentClassesName = getParentClassesName();
213 if (parentClassesName.length() > 0)
214 result.append("<FONT POINT-SIZE=\"12.0\"><B>" + parentClassesName
215 + "</B></FONT><br/>\n");
217 result.append("<FONT POINT-SIZE=\"25.0\"><B>" + getClassName(false)
218 + "</B></FONT>" + "</TD></TR>\n");
221 public List<FieldDescriptor> getAllFields() {
222 final List<FieldDescriptor> result = new ArrayList<FieldDescriptor>();
224 for (final Map.Entry<String, FieldDescriptor> entry : nameToFieldMap
226 result.add(entry.getValue());
231 public String getBackgroundColor() {
235 bgColor = "bgcolor=\"navajowhite2\"";
238 bgColor = "bgcolor=\"darkslategray1\"";
243 public String getBorderWidth() {
245 if (!areReferencesShown())
250 public String getClassName(final boolean differentiateArray) {
251 // this is needed for nested classes
252 final String actualClassName = classFullyQualifiedName
257 // for arrays use array component instead of array class name
258 result = arrayComponent.classFullyQualifiedName;
259 if (result.contains(".")) {
260 final int i = result.lastIndexOf('.');
261 result = result.substring(i + 1);
264 final int i = actualClassName.lastIndexOf('.');
265 result = actualClassName.substring(i + 1);
268 if (differentiateArray)
272 // this is needed for nested classes
273 // result = result.replace('$', '.');
277 public String getColor() {
278 if (getDistinctiveColor() == null)
279 setDistinctiveColor(Utils.getNextDarkColor());
281 return getDistinctiveColor();
284 public String getDistinctiveColor() {
285 return distinctiveReferenceColor;
289 public String getDot() {
296 final StringBuffer result = new StringBuffer();
298 generateDotHeader(result);
300 enlistFields(result);
302 enlistMethods(result);
304 result.append(" </TABLE>>, shape=\"none\"];\n");
306 enlistFieldReferences(result);
308 enlistMethodReferences(result);
310 enlistImplementedInterfaces(result);
312 enlistSuperClass(result);
314 return result.toString();
318 public String getEmbeddedDot() {
323 * Returns field with given name (case is ignored). Or <code>null</code> if
324 * field is not found.
326 public FieldDescriptor getFieldIgnoreCase(final String fieldToSearch) {
328 for (final String fieldName : nameToFieldMap.keySet())
329 if (fieldToSearch.equalsIgnoreCase(fieldName))
330 return nameToFieldMap.get(fieldName);
336 public String getGraphId() {
337 final String result = "class_"
338 + classFullyQualifiedName.replace('.', '_').replace(";", "")
339 .replace("[L", "").replace('$', '_');
343 public String getInterfaceColor() {
344 if (interfaceColor == null)
345 interfaceColor = Utils.getNextLightColor();
347 return interfaceColor;
350 private int getOutgoingReferencesCount() {
353 // count method references
354 for (final MethodDescriptor methodDescriptor : methods)
355 result += methodDescriptor.getOutsideVisibleReferencesCount();
357 // count field references
358 for (final FieldDescriptor fieldDescriptor : nameToFieldMap.values())
359 result += fieldDescriptor.getOutsideVisibleReferencesCount();
361 // count implemented interfaces
362 for (final ClassDescriptor classDescriptor : interfaces)
363 if (classDescriptor.isVisible())
367 if (superClass != null)
368 if (superClass.isVisible())
374 // public String getReadableName() {
376 // // do not print full class name for well known system classes
377 // final String packageName = getPackageName();
379 // if (packageName.equals("java.util"))
380 // return getClassName();
382 // if (packageName.equals("java.lang"))
383 // return getClassName();
385 // return fullyQualifiedName;
388 public String getPackageName() {
390 final int i = classFullyQualifiedName.lastIndexOf('.');
395 return classFullyQualifiedName.substring(0, i).replace("[L", "");
398 public String getParentClassesName() {
399 int i = classFullyQualifiedName.lastIndexOf('.');
400 final String fullClassName = classFullyQualifiedName.substring(i + 1);
402 i = fullClassName.lastIndexOf('$');
405 final String parentClassesName = fullClassName.substring(0, i);
406 return parentClassesName.replace('$', '.');
409 public String getSuperClassColor() {
410 if (superClassColor == null)
411 superClassColor = Utils.getNextLightColor();
413 return superClassColor;
417 * Checks if class has field with given name (case is ignored). Returns
418 * <code>true</code> if such field is found.
420 public boolean hasFieldIgnoreCase(final String fieldToSearch) {
422 for (final String fieldName : nameToFieldMap.keySet())
423 if (fieldToSearch.equalsIgnoreCase(fieldName))
433 public void hideClassIfNoReferences() {
437 final int totalReferencesCount = getOutgoingReferencesCount()
438 + referencesCount + extensionsCount + implementationsCount;
440 if (totalReferencesCount == 0) {
448 public void indexFields(final Field[] fields) {
449 for (final Field field : fields) {
450 if (nameToFieldMap.containsKey(field.getName()))
453 final FieldDescriptor fieldDescriptor = new FieldDescriptor(field,
459 private void indexMethods(final Class<? extends Object> clazz) {
460 final Method[] methods = clazz.getMethods();
462 for (final Method method : methods)
463 new MethodDescriptor(method, this, classGraph);
468 public boolean isVisible() {
470 if (Utils.isSystemDataType(classFullyQualifiedName))
473 if (Utils.isSystemPackage(classFullyQualifiedName))
476 if (!classGraph.getFilter().isClassShown(classFullyQualifiedName))
480 if (arrayComponent != null)
482 .isSystemDataType(arrayComponent.classFullyQualifiedName))
483 // Do not show references to primitive data types in arrays.
484 // That is: there is no point to show reference to byte when
485 // we have class with byte array field.
492 * Register event when another class is extending this one.
494 public void registerExtension() {
498 public void registerImplementation() {
499 implementationsCount++;
502 public void registerReference() {
506 public void setDistinctiveColor(final String distinctiveColor) {
507 distinctiveReferenceColor = distinctiveColor;