ToStringPlugin  HOME INDEX SEARCH CHANGES GO

Generate toString() plugin v2.20 Official homepage at: http://www.intellij.org/twiki/bin/view/Main/ToStringPlugin. Important note:Plugin v2.x supports both series of IDEA v3.x and v4.x/v4.5x.The older versions: v1.2x is for IDEA v3.x series and > v1.5x is for IDEA v4.x series. Introduction GenerateToString is a action plugin for IDEA that is used to create or update java classes toString() method. The reason is valuebeans usually needs to dump their field values for debug purpose, and it's tedious to write the dump code for this. This plugin generates the toString() method dumping all the fields in a simple manner. Usage Press alt + ins to active the generate menu and select toString. Example In the code below we need to override the public toString method so the fields can be dumped: public class MyServerConfigBean { private String name; private String url; private int port; private String[] validIPs; ... } After invoking the GenerateToString action the bean is now added with the following method public String toString() { return "MyServerConfigBean{" + "name='" + name + "'" + ", url='" + url + "'" + ", port=" + port + ", validIPs=" + (validIPs == null ? null : "length:" + validIPs.length + Arrays.asList(validIPs)) + "}"; } And if you change the fields you can run the action again and have it update the toString() method. In this situation where the toString() method already exists a dialog is displayed with options to: Replace existing method Create a new toString() method, so you'll have duplicate methods Cancel The plugin uses Velocity Template Language to generate the code, so it's very flexible if you want your toString method to be a little different. The template can be changed from the settings at File -> Settings -> GenerateToString. Enabled getters in code generation (since v2.15) Using this feature getter methods that does not directly use an existing field are avail in the Velocity Template Macro langauge as the variable $methods. The example again with getters enabled: public class MyServerConfigBean { private String name; private String url; private int port; private String[] validIPs; ... public String getServerAddress() { return url + ":" + port; } } And so after invoking the action, the result is: public String toString() { return "MyServerConfigBean{" + "name='" + name + "'" + ", url='" + url + "'" + ", port=" + port + ", serverAddress='" + getServerAddress() + "'" + ", validIPs=" + (validIPs == null ? null : Arrays.asList(validIPs)) + "}"; } The getter getServerAddress is now outputted in the toString method. Adding super class aware The plugin supports calling super.toString() in the generated code this is done using a test in the velocity macro. Here is an example: #if ($class.hasSuper) return super.toString() + " :: $classname{" + #else return "$classname{" + #end Settings You can change the settings of the plugin in File -> Settings (IDEA 4.x) or Options -> IDE Settings (IDEA 3.x). Configuration Description Use fully qualified classname The dumped classname will be including its packagename. (The $classname variable in the Velocity Context) Use field chooser dialog A dialog for selecting fields is used (like the getter/setter dialog). Always use default conflict resolution policy Will use the option selected from the Conflict Resoluction Policy settings. Disable action in code and editor popup menus If selected the Generate toString() action will not be visible in IDEA's Code and EditorPopup (right-click menu) Menus Enable on-the-fly code inspection If selected the code inspection for toString() will be run in the background (on-the-fly) and report any errors as warnings. This is like some existing IDEA code inspection for fields not used etc. Enable getters in code generation If selected the code generator will have $methods avail in the Velocity Macro Language. Default Conflict Resolution Policy Replace Existing = automatic replace existing toString() code. Duplicate = Create a duplicate toString() method (will not erase you existing code). Cancel = No code changes - remove the existing toString() method. Exclude fields (For constant fields) If checked then any fields that's a constant will not be part of avaiable fields for the code generator. Exclude fields (For static fields) If checked then any fields that's has a static modifier will not be part of avaiable fields for the code generator. Exclude fields (For transient fields) If checked then any fields that has a transient modifier will not be part of avaiable fields for the code generator. Exclude fields (By fieldname) Performs a regular expression matching on the fieldname. If the result is true the field will not be part of avaiable fields for the code generator. Exclude methods (By methodname) Performs a regular expression matching on the methodname. If the result is true the method will not be part of avaiable methods for the code generator. Automatic add implements java.io.Serializable Will automatic add implements Serializable to the java bean class if not already implemented. This is usefull for value objects that usually have to implement this interface for working in J2EE environments. Automatic import packages Will automatic import the packages. Additional packages can be seperated using comma. IDEA will optmize the imports so java.util.* will be optmized to java.util.List;java.util.Arrays etc. Can be used to import your own Classes that might be added to the generated code in the toString method. Templates A list of predefined templates to choose. To activate a new template first select it and click the Activate this template button. Active template Activates the current selected template. A confirm dialog will be prompted. Save template Saving the current template to a file. A file chooser dialog will be prompted. Syntax check Performs a Velocity syntax check of the current template code from the text area. Can be used to catch early syntax errors during customizing of teamplates. Method body (Velocity Macro Language) The java code for the toString() method body is generated using Velocity Macro Language. In this text area you can change how the code is generated. Excluding fields Usually you don't want constant fields as debug information in your toString() method. So you can check this filtering option, and prevent constant fields in the output. Also you can filter by the field's name. You could have an internal debug field not to be used in the toString method. So you type ^debug in the textfield By fieldname (regexp), to prevent debug fields. The example again using excluded fields: public class MyServerConfigBean { private final static String USERNAME = "scott"; private final static String PASSWORD = "tiger"; private String name; private String url; private int port; private String[] validIPs; private boolean debug = true; ... } And so after invoking the action, the result is still: public String toString() { return "MyServerConfigBean{" + "name='" + name + "'" + ", url='" + url + "'" + ", port=" + port + ", validIPs=" + (validIPs == null ? null : Arrays.asList(validIPs)) + "}"; } We do not output the constant fields (USERNAME, PASSWORD). And the regular expression excluded the debug field. The excluded fields will also not be in the choose fields dialog. Excluding methods (since v2.15) Only the methodname can be excluded for methods using a regular expression test. Typing ^getCausedBy.* in the textfield By methodname (regexp), to prevent outputting methods starting with the name getCausedBy. JavaDoc (since v2.14) It is possible to add javadoc comments to the generated toString() method. This is done by inserting the javadoc comments in the veloicty template. See the supplied javadoc templte example. A requirement is to use /** and */ enclosing the javadoc comments. The javadoc comments should be in the top of the template. Here is an example: /** * Insert your javadoc comments here * * @return a string representation of the object. */ return "$classname{}"; Template repository The template repository is a new feature in the settings dialog where you can choose a new template from the 4 included default templates. Additional templates stored in the folder IDEA_HOME\plugins\tostring-plugin will be listed also. Hence you can store your own templates in a text file (.vm, .txt or other) and have it listed here. This avoids any problem upgrading this plugin to a new version and loosing your customized template. Saving templates You can save your custom template to a file using the Save template button. The save dialog will default to the IDEA_HOME\plugins\tostring-plugin folder where it is possible to store additional templates to be listed in the template repository list. Storing templates outside this folder will not list the template in the list. If the filename has not been given an extension the .vm will be used (.vm = Velocity Macro). Autosaving active template The current active template is autosaved in the IDEA_HOME\plugins\tostring-plugin folder using the name __active_template_PLUGIN_VERSION.vm. This is to keep a backup of your template that come handy if any upgrading procedure somehow deletes your custom template. A Velocity Macro Example: The default template This is the default velocity template that is used in this plugin: #if ( $fields.size() > 0 ) #set ( $i = 0 ) return "$classname{" + #foreach( $field in $fields ) #if ( $i == 0 ) "## #else ", ## #end #if ( $field.objectArray ) $field.name=" + ($field.name == null ? null : Arrays.asList($field.name)) + #elseif ( $field.string ) $field.name='" + $field.name + "'" + #else $field.name=" + $field.name + #end #set ( $i = $i + 1 ) #end "}"; #else return "$classname{}"; #end The macro code can be changed to your needs. Just change the code in the text area. The active template is always the template that is editable. Inspection (since v2.13) This plugin provides two code inspections: Class does not overwrite toString() method Field not used in toString() method The Field not used in toString() method insepction can be used to identify out of synchronization situations where you have an existing toString() method that dumps the fields. However some fields have been added to the class later and these new fields are not dumped in the toString() method. This inspection can use on-the-fly code inspection by enabling it to show errors as warnings. This will highlight any unused fields on-the-fly in the java editor - also the right gutter will indicate the location of the error using a yellow marker. This is the same feature as the build in inspection 'Field XXX is never assigned'. Enabling the on-the-fly feature can be done from setting settings -> Errors -> ToString() Issues. Also on-the-fly should be enabled from the settings to the plugin. The inspection Class does not overwrite toString() method can be used to identify any classes where you might have forgotten to add a toString() method. This inspection will use the exclude settings from the plugin configuration to ignore classes having fields not supposed to be dumped. An additional settings is to exclude certain classes by using a regular expression matching their classname. As default this is used to exclude any Exception classes. This setting can be changed from settings -> Errors -> ToString() Issues. Also on-the-fly should be enabled from the settings to the plugin. Keymaps You can assign a keymap to this action from the settings. This keymap can be active even if the action is disabled from the code and editor popup menus. The Generate toString() action is located under other in the keymap tree. Velocity context There are now three type of elements avail in the macro language: Members ($member) Fields ($field) Methods ($method) A member is the common for both fields and methods. So using $member.string is the same as $field.string or $method.string. A field extends a member. Field have a few extra special field related attributes. A method extends a member. Method have a few extra special method related attributes. In the table below $member can be used for both $field and $method. The following variables are possible in the Velocity Template (variables are stored in the Velocity Context): Variable Returns Description $classname String The name of the class (can be the qualified classname if this is selected in the settings) $FQClassname String @deprecated (use $class.qualifiedName) - The fully qualified name of the class $fields java.util.List List of FieldElement objects $methods java.util.List List of MethodElement objects $members java.util.List List of both FieldElement and MethodElement objects $member Element The Element object $member.accessor String The accessor of the field or method. For field it is the $field.name and for method it is $method.methodName $member.typeName String The classname of the type (Object, String, List etc.) $member.typeQualifiedName String The qualified classname of the type (java.lang.Object, java.lang.String, java.uti.List etc.) $member.array boolean Tests if the type is an array type (either a primitve array or object array)? $member.primitiveArray boolean Is the type a primitve array type? (int[], short[], float[] etc.) $member.objectArray boolean Is the type an Object array type? (Object[], String[] etc.) $member.stringArray boolean Is the type an String array type? (String[]) $member.collection boolean Is the type assignable from java.util.Collection? $member.list boolean Is the type assignable from java.util.List? $member.map boolean Is the type assignable from java.util.Map? $member.set boolean Is the type assignable from java.util.Set? $member.primitive boolean Is the type a primitive type? (int, char, float etc.) $member.modifierStatic boolean Does the type have a static modifier? $member.modifierPublic boolean Does the type have a public modifier? $member.modifierProtected boolean Does the type have a protected modifier? $member.modifierPackageLocal boolean Does the type have a package-local modifier? $member.modifierPrivate boolean Does the type have a private modifier? $member.modifierFinal boolean Does the type have a final modifier? $member.string boolean Is the type assignable from java.lang.String? $member.numeric boolean Is the type either assignable from java.lang.Numeric or a primitive type of byte, short, int, long, float, double? $member.object boolean Is the type assignable from java.lang.Object? $member.date boolean Is the type assignable from java.util.Date? $member.calendar boolean Is the type assignable from java.util.Calendar? $member.boolean boolean Is the type assignable from java.lang.Boolean? or a primitive boolean $field FieldElement The FieldElement object $field.name String The name of the field $field.modifierTransient boolean Does the field have a transient modifier? $field.modifierVolatile boolean Does the field have a volatile modifier? $field.constant boolean Is the field a constant type? (has static modified and its name is in UPPERCASE only) $field.matchName(regexp) boolean Performs a regular expression matching on the fieldname. $method MethodElement The MethodElement object $method.name String Either: 1) The name of the field this getter method covers or 2) the name of the method 'getFoo' when the method does not cover a field as in situation 1 $method.methodName String The name of the method (getFoo). $method.fieldName String The name of the field this getter method covers $method.modifierAbstract boolean Is this method an abstract method? $method.modifierSynchronzied boolean Is this method a synchronzied method? $method.returnTypeVoid boolean Is this method a void method (does not return anything) ? $methor.getter boolean Is this a getter method? $method.matchName(regexp) boolean Performs a regular expression matching on the methodname. $class ClassElement The ClassElement object $class.name String The name of the class $class.matchName(regexp) boolean Performs a regular expression matching on the classname. $class.qualifiedName String The fully qualified name of the class $class.hasSuper boolean Does the class have a superclass? (extends another class - note extending java.lang.Object is not concidered having a superclass) $class.superName String The name of the superclass (empty if no superclass) $class.superQualifiedName String The fully qualified name of the superclass (empty if no superclass) $class.implements(interfaceNames) boolean Tests if the class implements the given interface name. Testing several interfaces names can be done by seperating the names with comma. Tests is based using the short classname. $class.implementNames String[] Returns the classnames of the interfaces the class implements. An empty array is returned if the class does not implement any interfaces. $class.extends(classNames) boolean Tests if the class extends any of the the given class names. Testing several class names can be done by seperating the names with comma. Tests is based using the short classname. The following output variables are possible in the Velocity Template (variables are stored in the Velocity Context): Output parameters will be available for the plugin generate after the veolicty context has executed and act upon. Variable Parameter Description $autoImportPackages String Packagenames that should automatically be imported. Use comma to seperate packagenames. Logging This plugin used log4j for logging. Logging can be enabled by editing the log4j.xml used by IDEA. The file is in the IDEA_HOME\bin folder. Add the category to this file: <category name="org.intellij.idea.plugin.tostring"> <priority value="DEBUG"/> <appender-ref ref="CONSOLE-ALL"/> </category> Disclaimer This plugin uses functions outside the openAPI (PSI for IDEA 3.x, Internal IDEA dialogs), so it might not work in the future if IDEA changes these core API's. IntelliJPluginWebForm IntelliJPluginName: Generate toString() IntelliJPluginVersion: 2.20 (IDEA 3.x, 4.x and 4.5x) IntelliJPluginVendor: Claus Ibsen IntelliJPluginBinary: IntelliJPluginSource: IntelliJPluginClassification: CodeHelper? TopicClassification: IntelliJPluginPackage TopicShortDescription: Generator for toString() method to dump the classes fields. Plugins for IDEA 3.x and IDEA 4.x. Official homepage at http://www.intellij.org/twiki/bin/view/Main/ToStringPlugin TestedOnOS: OsWin2K, OsWinXP ShouldRunOnOS: AnyOS Attachment: Action: Size: Date: Who: Comment: MikeAbneyTemplate.txt action 1087 12 Dec 2002 - 21:31 MikeAbney v1.0 SpencerGohTemplate.txt action 944 21 Jan 2003 - 11:55 SpencerGoh v.1.0 - Concise mod base-template (StringBuffer?) tostring-plugin.jar action 103698 18 Jan 2005 - 14:30 DavsClaus v2.20 for all IDEA 4 versions tostring-plugin-src.jar action 86144 18 Jan 2005 - 14:31 DavsClaus v2.20 - SOURCE only TomGagnierTemplate.txt action 648 01 Feb 2004 - 02:57 TomGagnier v1.03 correct primitive array bug tostring-plugin-idea3v212.jar action 73911 19 Apr 2004 - 08:24 DavsClaus v2.12 - Compiled for IDEA 3.x

e d i t a t t a c h r e f - b y d i f f s m o r e Have ideas, requests, problems regarding this site? Send feedback. Copyright © 2000-2003 by the contributing authors. All materials at intellij.org are the property of the contributing authors.