- 1. General
- 1.1. Where can I ask a question that isn’t answered here?
- 1.2. Does Jalopy only support Java?
- 1.3. What platforms are covered?
- 1.4. Can I use Jalopy with my IDE?
- 1.5. Is there a trial version that I can test?
- 1.6. How does the commercial version differ from the SourceForge Jalopy?
- 1.7. Does Jalopy support batch formatting of entire directories?
- 1.8. How does Jalopy handle trailing white space?
- 2. Licensing & Pricing
- 3. Installation
- 3.1. The installation instructions state that I should execute a "jalopy-setup-1.9.4.jar" file, but when I downloaded this was a ".zip" file, not ".jar" and double-clicking does not start the installation process. How about that?
- 3.2. Invoking the installer under Linux yields a blank window. Are there any known problems with the installer?
- 3.3. Is there an Eclipse update site that I can use for installation?
- 3.4. Is it possible to install the plug-in into the Eclipse dropins folder?
- 3.5. After installation of the Jalopy plug-in under Eclipse 3.0, the plug-in shows unexpected behavior like formatting a file freezes the workspace or does not show at all. How can I make the plug-in work?
- 3.6. Settings are stored below $HOME/.jalopy by default, but I would prefer to have the settings sit in another location. Is it possible to change the directory?
- 4. Configuration
- 4.1. What is a code convention?
- 4.2. How do I export my code convention?
- 4.3. Jalopy wrongly increases the indentation of code lines with every formatting run. How can this be avoided?
- 4.4. Jalopy includes the same header every time it is invoked again. How can this be avoided?
- 4.5. Jalopy reports "unexpected token XXX" when I’m trying to format a file that contains an enum declaration. I’d expected Jalopy fully supports all new J2SE 5.0 language features?
- 4.6. I want to disable the insertion of separator comments for certain code sections. Is this possible?
- 4.7. Is it possible to disable formatting for certain code sections?
- 4.8. I’m using the Eclipse/Jalopy tandem in order to generate missing Javadoc comments, but Jalopy even generates comments for elements that are marked as (non-Javadoc) by Eclipse. How can this be avoided?
- 4.9. The screen shots on your site look neat. How is that?
- 4.10. OK, now I know what Look & Feel I want to use - but how to install it?
- 4.11. After upgrading, formatting always yields the error message: “Don’t know what profile to use for project ’foo’. Please either add an alias to the desired profile. Or add a matching profile for the project. Or enable project specific settings”. How do I fix this?
- 5. Bugs
- 5.1. How do I report a bug I have found in Jalopy?
- 5.2. What information should I include in a bug report?
- 5.3. I am receiving java.lang.OutOfMemoryError: PermGen space exceptions when trying to invoke the Preferences Dialog within Eclipse 3.2. How is that?
- 5.4. I am receiving java.lang.IncompatibleClassChangeError errors when working under WSAD 5.1 (running under a IBM 1.3 VM). Is there a way to circumvent this issue?
1. General | |||||||||
1.1. | Where can I ask a question that isn’t answered here? | ||||||||
Please contact us | |||||||||
1.2. | Does Jalopy only support Java? | ||||||||
Currently, yes. But we plan to add support for more languages. Please tell us what language support is most important to you | |||||||||
1.3. | What platforms are covered? | ||||||||
Jalopy runs on all common platforms, i.e. Linux, Mac OS X, Solaris, Unix and Windows 2000 or later | |||||||||
1.4. | Can I use Jalopy with my IDE? | ||||||||
Most likely. Please refer to the plug-ins page for a list of the supported 3rd party applications | |||||||||
1.5. | Is there a trial version that I can test? | ||||||||
Yes, we provide fully functional trial versions of our products. There is an online form that you can use to submit your details | |||||||||
1.6. | How does the commercial version differ from the SourceForge Jalopy? | ||||||||
See here | |||||||||
1.7. | Does Jalopy support batch formatting of entire directories? | ||||||||
Sure thing! All provided plug-ins enable you to format entire directories, projects or workspaces. Please refer to the plug-ins section in the user’s guide for detailed information. It’s also possible to define global exclusion filters to prevent certain files and/or directories from formatting | |||||||||
1.8. | How does Jalopy handle trailing white space? | ||||||||
Trailing white space is always removed! | |||||||||
2. Licensing & Pricing | |||||||||
2.1. | What is the Jalopy licensing scheme? | ||||||||
See the licensing and pricing page for details. | |||||||||
2.2. | Is Jalopy Open Source? | ||||||||
No, the Jalopy source code formatter provided by TRIEMAX Software is commercial software. It is the successor of the SourceForge hosted Open Source project with the same name, that was originally created by the founder of TRIEMAX Software. To learn more about the Open Source Jalopy visit http://jalopy.sourceforge.net/ Jalopy site licenses come with full source code for the application, so if you are concerned about being able to make your own in house customizations or the ability to modify functionality/ fix bugs yourself, this is still possible | |||||||||
3. Installation | |||||||||
3.1. |
The installation instructions state that I should execute a
| ||||||||
This is a known quirk with Microsoft Internet Explorer. It sometimes downloads .jar files as .zip files. You can simply rename the extension to ".jar" and things should work as advertized. Or use another browser like Firefox, Opera, Safari for downloading. They don’t exhibit similar behavior | |||||||||
3.2. | Invoking the installer under Linux yields a blank window. Are there any known problems with the installer? | ||||||||
The installer should be fine, but there is a known incompability with older Java versions and compositing window managers like Compiz or Beryl. The issue is tracked by the following bug id http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6429775 which provides insight and workarounds. The best strategy to prevent the issue is to either disable the compositing manager altoghether, or update to a more recent VM. The problem seems to be fixed with Java 1.6.0_10 or later | |||||||||
3.3. | Is there an Eclipse update site that I can use for installation? | ||||||||
There is no public Eclipse update site available, but you can easily create your own and tell Eclipse to install the plug-in from there. Please refer to the How do I install from an Eclipse update site? How-To | |||||||||
3.4. | Is it possible to install the plug-in into the Eclipse dropins folder? | ||||||||
Sure, the setup wizard supports installation into the dropins folder. But because the Eclipse p2 provisioning platform favors feature installation, it doesn’t do so by default. Simply select the dropins folder as the installation target and the installer won’t use the provisioning system directly and simply copy the plug-in files into the dropins folder, where they should get picked up by the provisioning system | |||||||||
3.5. | After installation of the Jalopy plug-in under Eclipse 3.0, the plug-in shows unexpected behavior like formatting a file freezes the workspace or does not show at all. How can I make the plug-in work? | ||||||||
It might be that the plug-in has not been correctly initialized. The plug-in may
not load up at all or is not correctly working in such a case. You can use the
Eclipse You can specify the option either on the command-line, e.g. start Eclipse with the following command: % eclipse -clean
Or you could add the option to your You can find more information about the Eclipse runtime system and possible configuration options online at the Eclipse web site or in the local Eclipse SDK Help System via Help → Help Contents → Platform plug-in Developer Guide → Reference → Other reference information → Runtime options | |||||||||
3.6. | Settings are stored below $HOME/.jalopy by default, but I would prefer to have the settings sit in another location. Is it possible to change the directory? | ||||||||
Yes, you can control the location of the settings directory via the "triemax.jalopy.home" Java system property. % java -jar jalopy-1.9.4.jar -Dtriemax.jalopy.home=/usr/jalopy/settings/ [...] Please consult the documentation of your IDE or build tool on how to specify Java system properties. For instance, Eclipse uses the following notation: % eclipse -vmargs -Dtriemax.jalopy.home=/usr/jalopy/settings/ [...] You probably want to add this line to your eclipse.ini to apply the changes permanently | |||||||||
4. Configuration | |||||||||
4.1. | What is a code convention? | ||||||||
As far as Jalopy is concerned, a code convention is the bag of settings that ultimately describe the style of a source file. A code convention is usually shared in a textual XML format | |||||||||
4.2. | How do I export my code convention? | ||||||||
Please refer to the Settings Export How-To or Settings Export from Eclipse How-To if you’re using an Eclipse-based IDE | |||||||||
4.3. | Jalopy wrongly increases the indentation of code lines with every formatting run. How can this be avoided? | ||||||||
Tab characters are replaced during parsing with a certain number of spaces that need to match the original tab width. To correctly format files with hard tabs, you may need to adjust the "Original Tab indent" setting. See the Indentation section in the user’s guide for more information | |||||||||
4.4. | Jalopy includes the same header every time it is invoked again. How can this be avoided? | ||||||||
You need to specify an identify key that allows Jalopy to recognize an existing header. Please refer to the Header section in the user’s guide for more information | |||||||||
4.5. | Jalopy reports "unexpected token XXX" when I’m trying to format a file that contains an enum declaration. I’d expected Jalopy fully supports all new J2SE 5.0 language features? | ||||||||
Jalopy does support all new syntax features introcucec with J2SE 5.0, but you
might need to configure it accordingly. With the introduction of the new
Please refer to the user’s guide for information how to change the compliance level. You can find the appropriate information in the Java Misc section in the user’s guide | |||||||||
4.6. | I want to disable the insertion of separator comments for certain code sections. Is this possible? | ||||||||
Yes, you need to remove the description text for each section that should have no separator comment inserted. Refer to the Separator Comments section in the user’s guide for more information | |||||||||
4.7. | Is it possible to disable formatting for certain code sections? | ||||||||
Yes, you can place the two pragma comments | |||||||||
4.8. |
I’m using the Eclipse/Jalopy tandem in order to generate missing Javadoc
comments, but Jalopy even generates comments for elements that are marked
as | ||||||||
By default, Eclipse uses a multi-line comment to point to documentation
contained in a super class. Change the template for the
/* (non-Javadoc)
* ${see_to_overridden}
*/
to /**
* ${see_to_overridden}
*/
| |||||||||
4.9. | The screen shots on your site look neat. How is that? | ||||||||
Most screen shots have been made using the Quaqua Look & Feel running Mac OS X 10.5 with the Quartz rendering pipeline. Quaqua is a Look & Feel enhancement that runs on top of Apple’s Aqua Look & Feel. You can find more information here: http://www.randelshofer.ch/quaqua/download.html http://javootoo.l2fprod.com/ is a good starting point if you’re looking for Java Look & Feels. It provides short descriptions and sample screen shots for probably most of the currently available Look & Feels (both free and commercial). | |||||||||
4.10. | OK, now I know what Look & Feel I want to use - but how to install it? | ||||||||
Depends on your application. The Jalopy preferences tool supports the
Either copy the .jar into the % jalopy --configure --look quaqua
Replace the Or you could provide the library path directly to the Java launcher (everything goes into one line!) % java -cp D:\libs\synthetica.jar;D:\tools\jalopy\lib\jalopy-1.9.4.jar / Jalopy --configure --look synthetica Applications like NetBeans or IntelliJ IDEA often provide similar support for custom Look & Feels. Please consult the documentation of your application. | |||||||||
4.11. | After upgrading, formatting always yields the error message: “Don’t know what profile to use for project ’foo’. Please either add an alias to the desired profile. Or add a matching profile for the project. Or enable project specific settings”. How do I fix this? | ||||||||
If several Jalopy profiles are defined, Jalopy now enforces that all IDE projects are mapped to a Jalopy profile to fix a flaw with automatic profile switching. To make things as easy as possible you can now define a default profile that will be used if no more specific mapping rules apply for a project. To fix the error message, open the Jalopy preferences, select the profile you want to use as the default profile, press the Aliases... button and add the catch-all alias ’*’ to the profile. You can learn more about profiles and project mapping in the user guide | |||||||||
5. Bugs | |||||||||
5.1. | How do I report a bug I have found in Jalopy? | ||||||||
Either use the bug reporting form or post to the jalopy-user mailing list | |||||||||
5.2. | What information should I include in a bug report? | ||||||||
The web form provides several fields for submitting information. If you are unsure about a particular item, just leave it empty When you write your initial comment describing the bug, you should specify the versions of
ALWAYS include or attach your code convention as many errors only occur with a certain settings combination. Refer to Q: 4.2 for more information on how you can export your code convention to a file Be as specific as possible. If you encounter stack traces, add them. If you have problems formatting a specific file, locate the cause of the error and paste the code section. Every bit of information helps. Thank you! | |||||||||
5.3. |
I am receiving | ||||||||
This seems to be a issue that only appears when using a Sun VM. In order to make things work again, you need to increase the perm space using the -XX:MaxPermSize option as explained in the Eclipse readme. The default value depends on the used VM, and until 1.5.0_06 was no bigger than 64MB, so using -XX:MaxPermSize=128m might be sufficient for most cases. But since 1.5.0_07 the default is 256MB. If you happen to use this version and still encounter OutOfMemory problems, you would need to increase the value even further. In order to increase the size of the VM perm space, start Eclipse with the following runtime options: % eclipse -vmargs -XX:MaxPermSize=128m
Or you could add the option to your You can find more information about the Eclipse runtime system and possible configuration options online at the Eclipse web site or in the local Eclipse SDK Help System via Help → Help Contents → Platform plug-in Developer Guide → Reference → Other reference information → Runtime options | |||||||||
5.4. |
I am receiving | ||||||||
The IBM 1.3 VM contains a bug that prevents the obfuscated code to function properly. Please contact support in order to receive instructions how to bypass the problem |