jSparrow
FAQ
Your comprehensive list of frequently asked questions and troubleshooting
Installation
Where do I install jSparrow?
Please drag and drop this button into your Eclipse IDE:
Installation Troubleshooting
Installation Video
I could not install jSparrow
Please open your Eclipse IDE and try downloading jSparrow directly from the built-in Eclipse marketplace
I tried installing via the Eclipse IDE marketplace, still doesn’t work
Please try the manual installation guide for jSparrow
I tried the manual installation, it still doesn’t work
Please use the Report an Issue form and we’ll do our best to help you as soon as possible
Support
I need help
Please feel free to use our contact form to contact us. You can also send your message here: office@jsparrow.io
Subscription
How to unsubscribe Billed Licenses?
To unsubscribe from a jSparrow product go to your orders, then sign in with the e-mail you used to buy and wait for the log-in link from FastSpring. Click on “manage” on your bought product and there should be options to unsubscribe.
How to unsubscribe from Newsletter?
To unsubscribe from the jSparrow newsletter please open the latest newsletter and scroll down to the footer of the e-mail, there you will find the unsubscribe link.
Plugin Q/A
Does the plugin store my code or files?
No
Does the plugin store my activities?
No
Does the plugin use AI?
No. AI tools can suggest refactorings in amazing speeds, but the computed suggestion has not been tested and might be insecure. Instead of AI, our developers implements and tests all our rules extensively in-house.
A plus is that jSparrow can suggest a multitude of quick-fixes across Java files AND it allows you to review everything in the diff-view.
Does the plugin send code snippets to an external server?
No. Both the analysis and refactoring happen completely offline.
The plugin is based on Eclipse JDT which is provided within the IDE. The plugin does not transfer the code to any external server or third party.
Can I use the plugin locally, without internet access?
Yes, everyone can compute all refactorings completely offline.
Internet is needed when you wish to save or persist locked refactorings. For this jSparrow uses the NetLicensing public API to validate your license key.
We can also provide offline validation servers:
If your company worry about security or sensitive access, we can provide an offline validation server.
If code breaks when I use jSparrow, who is responsible?
We do not recommend using any tools or plugins without having a reliable backup process for all your projects. jSparrow can not take responsibility for code breaks although we extensively test all rules with a multitude of test cases before releasing a refactoring.
We recommend working closely with the plugin as it allows you to review the original and the refactored code in its diff view. You can easily deselect changes you don’t want before committing there.
To avoid potential programming disasters, we also recommend having a backup process as a crucial part of your pipeline.
Do you still make new rules?
Yes! You can check the next release date at the bottom of our Eclipse Marketplace Page.
I found a bug in jSparrow
We’re sorry to hear that. Please use the Report an issue form so we can fix it immediately.
What is jSparrow?
Non-technical version
This tool is all about precision and keeping your code in top shape. jSparrow can help you maintain the high code standard you aim for. It’s like having a personal assistant for “refactoring” – that’s the fancy term for cleaning your code without changing the necessary features.
jSparrow’s Pipeline (Quite technical)
For each selected Java source file, a new state is created. Each state consists of the original file and a working copy that is subsequently analyzed with the refactoring rules. jSparrow then iterates over all the states, parses each working copy, and applies all the selected rules to it.
The working copies are then parsed and adjusted after each rule execution. Important: on this step, the original sources remain intact.
As a final step, the developer can (un)select changes and when the developer is ready, they can click on “finish”. Then the selected refactorings will be persisted on the original sources.
Some refactoring rules have requirements e.g. minimum Java version. Therefore, jSparrow’s pipeline contains functionalities to dump or recompute refactorings of certain rules on certain files to adhere to the requirements.
Is jSparrow Safe?
Yes, jSparrow is safe. Over 6000+ people use jSparrow in their projects. We’re also an established IT-consulting company since 2004.
Eclipse IDE Plugin In-Depth
jSparrow Rule Profiles
We thought that maybe developers don’t want all the rules at once, so we created profiles where you can group rules together to ease the workflow.
To create a new profile please see how to add profiles.
Markers / Quick-fixes
The jSparrow Markers make use of the JDT support for so-called Quick Fixes. Markers give you the ability to click on and choose an automatic fix to various problems.
The jSparrow Markers work like the Quick Fixes of Sonarlint and JDTSpelling.
jSparrow’s markes are included for free in the base product and are available after installing jSparrow.
Quick link to how to de-activate markers.
Logging (Interactive UI Included)
The ‘System out to logging’ rule is an interactive Rule and it introduces the replacement of System.out statements (println, error, e.printstacktrace) with a logging statement. This rule requires the configuration of a logging environment (log4j, slf4j).
Quick link to how to configure Logging.
Rename Fields (Interactive UI Included)
The ‘Rename Fields ‘ rule is an interactive Rule. This rule finds fields that do not comply with the Java Naming Conventions and renames them according to your choices.
Quick link to how to configure Rename Fields.
Remove Unused Code (Interactive UI Included)
This wizard makes it easy to remove Unused Methods, Unused Fields, and Unused Types.
Other Environments and IDEs
jSparrow Maven and Cloud App
jSparrow is a plugin for Eclipse IDE, Maven, and GitHub. However, jSparrow for Maven and GitHub is currently only available through contacting us. You’ll work tightly with one of our inhouse-developers because of potential library restrictions.
Additionally, we are currently working on introducing jSparrow to Visual Studio Code.
Free vs. Paid
What is the difference?
The main difference is that the free or base version contains 20 free rules while a license allows you to instantly save the changes suggested by all the rules and the rules that have their own interactive UI.
Today jSparrow has 000 rules available.
Other benefits from the free version are the markers and the choice to see the before-and-after refactoring of all rules.
Today jSparrow has 000 markers of the 000 rules available.
The only downside is that, if you were to try the locked rules, you won’t be able to apply their refactorings without a license. But we think that this way, you’ll easily know if you need a license or not, maybe all you need is the free version!
What are the free rules?
Our free jSparrow version contains these 20 free rules, accessible directly after installation:
- Collapse If Statements
- Replace equals() on Enum Constants
- Replace For-Loop with Enhanced-For-Loop
- Replace Expression Lambda with Method Reference
- Split Multiple Variable Declarations
- Use Optional::filter
- Organize Imports
- Use @Override Annotation
- Remove Boxing for String Conversions
- Remove Double Negations
- Remove Unnecessary Semicolons
- Remove Null-Checks Before Instanceof
- Remove Unnecessary Thrown Exceptions on Method Signatures
- Remove toString() on String
- Reorder String Equality Check
- Replace Inefficient Constructors with valueOf()
- Use Try-With-Resource
- Replace Equality Check with isEmpty()
- Use Offset Based String Methods
- Use SecureRandom
Licensing and Plans Q/A
Is there a refund guarantee?
In general, we do not offer refunds because we do not track your plugin activities and we can therefore not know if you have already used the refactorings on your sources. However, sometimes accidents happen: if you contact us the day you got billed because you forgot to unsubscribe, we will refund you.
I have bought a license but with a different price, what will happen with my plan?
We no longer offer the plans you are looking for. However, if you were recently subscribed to a plan it is possible for you to go to your orders and activate that subscription. We think it’s fair that you get to keep your subscription plan.
Why is there only an enterprise plan and a student plan?
We no longer offer a B2C plan (the exception is students). We aim to serve companies within IT. However, please feel free to use the free version or contact us and we can discuss your needs.
Is there an enterprise plan?
Yes, we at Splendit IT-Consulting know that legacy software is at the core of many enterprises (jSparrow was developed with enterprises in mind). Please contact us and we’ll help you find the right plan.
License Troubleshooting
I have issues with my license
We’re sorry to hear that. Please contact us via the Report an issue form and we will help you fix the issues.
I did not receive a license key
We apologize for the inconvenience! We found out that our reseller FastSpring can take up to 20 minutes to send you the key.
If it takes longer please contact us via the Report an issue form and we will send it to you personally.
My license key does not work
We’re very sorry to hear that. Please contact us via the Report an issue form
I have a node-locked license but I can’t use my PC because of [reason], what can I do?
Don’t worry about it, contact us via the Report an issue form and we will reset the key for you out of charge.
I have paid for a license but jSparrow is down because of [reason], how will I get compensated?
Usually, we do not put jSparrow down for any reason, but if it were to happen we will make sure to update your license to fit the subscription span and move the billing date.
Is jSparrow down for you? Please use the Report an issue form so we can help you solve the issue