User Manual - White Magic Software
Contents
1. 9 Accepting Warranty or Additional Liability While redistributing the Work or Derivative Works thereof You may choose to offer and charge a fee for acceptance of support warranty indemnity or other liability obligations and or rights consistent with this License However in accepting such obligations You may act only on Your own behalf and on Your sole responsibility not on behalf of any other Contributor and only if You agree to indemnify defend and hold each Contributor harmless for any liability incurred by or claims asserted against such Contributor by reason of your accepting any such warranty or additional liability License 9 www whitemagicsoftware com User Manual 27 Sep 20092. HIERARCHY INHERITANCE DIAGRAMS FOR JAVA USER MANUAL HIERARCHY INHERITANCE DIAGRAMS FOR JAVA CONTENTS T Introduction ciaci n 1 4 USAGE in 4 1s PUOSC iran 1 4 1 Display Commande 4 1 2 Instala ON EE 1 4 1 1 Keyboard Controle 4 2 RequirementS ccocccnccccnannccaoanonananonanass 2 4 1 2 Mouse Controle iissiraiscsssiiiiiiinsss 4 E 2 4 2 Example Grape 5 CR RE 2 4 2 1 AS 5 CR EE 3 EE 34 Windows 3 4 3 Command Line Optons 5 A Golan tives 3 S Lopwgrigbt EE 6 A A 3 6 Ueenge ENEE 7 Contents i www whitemagicsoftware com User Manual 27 Sep 2009 HIERARCHY INHERITANCE DIAGRAMS FOR JAVA 1 INTRODUCTION This document describes how to use the Hierarchy software application 1 1 PURPOSE The purpose to Hierarchy is to create a visually appealing Java class inheritance hierarchy with minimal effort by software developers 1 2 INSTALLATION Unzipping the archive is the only installation step Introduction 1 www whitemagicsoftware com User Manual 27 Sep 2009 HIERARCHY INHERITANCE DIAGRAMS FOR JAVA 2 REQUIREMENTS This section discusses the software requirements that must be met to run the application 2 1 JAVA The Java runtime environment J2RE or the Java software development kit J2SDK version 1 6 or greater is required to run the application 2 1 1 VERIFY To verify which version of Java is currently installed complete the following steps 1 Open a terminal window or comma
3. This section describes the keyboard and mouse controls for the application 4 1 1 KEYBOARD CONTROLS The keyboard controls for Hierarchy are listed in Table 4 1 Key Action Zoom into the display Zoom out of the display Control q Quit hierarchy Control s Save the graph to a file Table 4 1 Application Keyboard Controls 4 1 2 MOUSE CONTROLS The mouse controls for Hierarchy are listed in Table 4 2 Button Action Left Click and hold to drag the entire graph Right Click to fit the graph to the visible area Right Click and hold while moving the mouse to zoom Table 4 2 Application Mouse Controls Resizing the window will automatically zoom the graph Usage 4 www whitemagicsoftware com User Manual 27 Sep 2009 HIERARCHY INHERITANCE DIAGRAMS FOR JAVA 4 2 EXAMPLE GRAPHS This section provides a few examples on how to create graphs using Hierarchy The algorithm to determine how to lay out the graph is not completely deterministic As such the graph might appear differently between runs 4 2 1 EXAMPLE 1 Execute the following command to see the class hierarchy for java awt Window lt run gt c java awt Window 4 2 2 EXAMPLE 2 Execute the following command to see a subset of the class hierarchy for java awt Window lt run gt c java awt Window exclude sun java awt Container com sun This example uses a simplified regular expression patte
4. ated documentation and conversions to other media types Work shall mean the work of authorship whether in Source or Object form made available under the License as indicated by a copyright notice that is included in or attached to the work an example is provided in the Appendix below Derivative Works shall mean any work whether in Source or Object form that is based on or derived from the Work and for which the editorial revisions annotations elaborations or other modifications represent as a whole an original work of authorship For the purposes of this License Derivative Works shall not include works that remain separable from or merely link or bind by name to the interfaces of the Work and Derivative Works thereof Contribution shall mean any work of authorship including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof that is intentionally submitted to License 7 www whitemagicsoftware com User Manual 27 Sep 2009 HIERARCHY INHERITANCE DIAGRAMS FOR JAVA Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner For the purposes of this definition submitted means any form of electronic verbal or written communication sent to the Licensor or its representatives including but not limited to communication on electronic mailing lists source code control syst
5. ems and issue tracking systems that are managed by or on behalf of the Licensor for the purpose of discussing and improving the Work but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as Not a Contribution Contributor shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work 2 Grant of Copyright License Subject to the terms and conditions of this License each Contributor hereby grants to You a perpetual worldwide non exclusive no charge royalty free irrevocable copyright license to reproduce prepare Derivative Works of publicly display publicly perform sublicense and distribute the Work and such Derivative Works in Source or Object form 3 Grant of Patent License Subject to the terms and conditions of this License each Contributor hereby grants to You a perpetual worldwide non exclusive no charge royalty free irrevocable except as stated in this section patent license to make have made use offer to sell sell import and otherwise transfer the Work where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution s alone or by combination of their Contribution s with the Work to which such Contribution s was submitted If You institute patent litigation against any entity inc
6. luding a cross claim or counterclaim in a lawsuit alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement then any patent licenses granted to You under this License for that Work shall terminate as Of the date such litigation is filed 4 Redistribution You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium with or without modifications and in Source or Object form provided that You meet the following conditions a You must give any other recipients of the Work or Derivative Works a copy of this License and b You must cause any modified files to carry prominent notices stating that You changed the files and c You must retain in the Source form of any Derivative Works that You distribute all copyright patent trademark and attribution notices from the Source form of the Work excluding those notices that do not pertain to any part of the Derivative Works and d If the Work includes a NOTICE text file as part of its distribution then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file excluding those notices that do not pertain to any part of the Derivative Works in at least one of the following places within a NOTICE text file distributed as part of the Derivative Works within the Source form or documentation if provided along with the De
7. nd shell 2 Type java version Depending on your operating system you should see output similar to the following java version 1 6 0_16 Java TM SE Runtime Environment build 1 6 0 16 b01 Java HotSpot TM 64 Bit Server VM build 14 2 b01 mixed mode The version number is highlighted in bold Requirements 2 27 Sep 2009 www whitemagicsoftware com User Manual HIERARCHY INHERITANCE DIAGRAMS FOR JAVA 3 RUNNING This section discusses how to run Hierarchy In all cases you must 1 Open a terminal window or command prompt 2 Change into Hierarchy subdirectory where the Hierarchy archive was unzipped 3 1 WINDOWS For Microsoft Windows execute the following command run bat 3 2 UNIX For Unix based operating systems e g MacOS or Linux execute the following commands chmod x run sh run sh The chmod command need only be run the first time to set the executable bit of the shell script 3 3 JAVA To run Hierarchy manually execute the following command java Xms64m Xmx1024m jar lib hierarchy jar Running 3 www whitemagicsoftware com User Manual 27 Sep 2009 HIERARCHY INHERITANCE DIAGRAMS FOR JAVA 4 USAGE This section describes a few example usages of the Hierarchy application Throughout this section lt run gt refers to executing Hierarchy as outlined in section 3 4 1 DISPLAY COMMANDS There are a number of ways to interact with Hierarchy
8. ons under the License Copyright 6 www whitemagicsoftware com User Manual 27 Sep 2009 HIERARCHY INHERITANCE DIAGRAMS FOR JAVA 6 LICENSE Apache License Version 2 0 January 2004 http www apache org licenses TERMS AND CONDITIONS FOR USE REPRODUCTION AND DISTRIBUTION 1 Definitions License shall mean the terms and conditions for use reproduction and distribution as defined by Sections 1 through 9 of this document Licensor shall mean the copyright owner or entity authorized by the copyright owner that is granting the License Legal Entity shall mean the union of the acting entity and all other entities that control are controlled by or are under common control with that entity For the purposes of this definition control means i the power direct or indirect to cause the direction or management of such entity whether by contract or otherwise or ii ownership of fifty percent 50 or more of the outstanding shares or iii beneficial ownership of such entity You or Your shall mean an individual or Legal Entity exercising permissions granted by this License Source form shall mean the preferred form for making modifications including but not limited to software source code documentation source and configuration files Object form shall mean any form resulting from mechanical transformation or translation of a Source form including but not limited to compiled object code gener
9. rivative Works or within a display generated by the Derivative Works if and wherever such third party notices normally appear The contents of the NOTICE file are for informational License 8 www whitemagicsoftware com User Manual 27 Sep 2009 HIERARCHY INHERITANCE DIAGRAMS FOR JAVA purposes only and do not modify the License You may add Your own attribution notices within Derivative Works that You distribute alongside or as an addendum to the NOTICE text from the Work provided that such additional attribution notices cannot be construed as modifying the License You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use reproduction or distribution of Your modifications or for any such Derivative Works as a whole provided Your use reproduction and distribution of the Work otherwise complies with the conditions stated in this License 5 Submission of Contributions Unless You explicitly state otherwise any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License without any additional terms or conditions Notwithstanding the above nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions 6 Trademarks This License does not grant permission to use the trade names tradema
10. rks service marks or product names of the Licensor except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file 7 Disclaimer of Warranty Unless required by applicable law or agreed to in writing Licensor provides the Work and each Contributor provides its Contributions on an AS IS BASIS WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND either express or implied including without limitation any warranties or conditions of TITLE NON INFRINGEMENT MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License 8 Limitation of Liability In no event and under no legal theory whether in tort including negligence contract or otherwise unless required by applicable law such as deliberate and grossly negligent acts or agreed to in writing shall any Contributor be liable to You for damages including any direct indirect special incidental or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work including but not limited to damages for loss of goodwill work stoppage computer failure or malfunction or any and all other commercial damages or losses even if such Contributor has been advised of the possibility of such damages
11. rn to specifically exclude gt all classes whose package namespace begins with sun gt all classes whose package namespace begins with com sun gt the class java awt Container The result should appear similar to Figure 4 1 java awt Window javax swing JWindow java awt Dialog java awt Frame A A java awt FileDialog javax swing JDialog javax swing JFrame A javax swing ColorChooserDialog Figure 4 1 java awt Window Class Hierarchy 4 3 COMMAND LINE OPTIONS There are a number of command line options that can be used to control various aspects of the resulting graph Run the application without specifying any options to see an overview of the various options Usage 5 www whitemagicsoftware com User Manual 27 Sep 2009 HIERARCHY INHERITANCE DIAGRAMS FOR JAVA 5 COPYRIGHT Copyright 2009 White Magic Software Ltd Licensed under the Apache License Version 2 0 the License you may not use this file except in compliance with the License You may obtain a copy of the License at http www apache org licenses LICENSE 2 0 Unless required by applicable law or agreed to in writing software distributed under the License is distributed on an AS IS BASIS WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND either express or implied See the License for the specific language governing permissions and limitati
Download Pdf Manuals
Related Search