Generate code

Aqua provides multiple ways to generate common code constructs and recurring elements, which helps you increase productivity. These can be either file templates used when creating a new file, custom or predefined live templates that are applied differently based on the context, various wrappers, or automatic pairing of characters.

Additionally, Aqua provides code completion and Emmet support.

Generate constructors

Aqua can generate a constructor that initializes specific class fields using values of corresponding arguments.

Generate a constructor for a class

In the main menu, go to Code and select Generate (Alt+Insert).
In the Generate popup, click Constructor.
If the class contains fields, select the fields to be initialized by the constructor and click OK.

The following code fragment shows the result of generating a constructor for a class:

            public class MyClass {
                int aInteger;
                double bDouble;

                public MyClass(int myAIntegerParam, double myBDoubleParam) {
                    aInteger = myAIntegerParam;
                    bDouble = myBDoubleParam;
                }
            }
        

Generate delegation methods

Aqua can generate methods that delegate behavior to the fields or methods of your class. This approach makes it possible to give access to the data of a field or method without directly exposing this field or method.

Generate a delegation method for a class

In the main menu, go to Code and select Generate (Alt+Insert).
In the Generate popup, click Delegate Methods.
Select the target field or method, and click OK.
Select the desired methods to be delegated and click OK.

The following code fragment shows the result of delegating the get(i) method of the Calendar class inside another class:

            Calendar calendar;
            public int get(int i) {
                return calendar.get(i);
            }
        

Generate equals() and hashCode() methods

The Java super class java.lang.Object provides two methods for comparing objects:

public boolean equals(Object obj) returns true if the object passed to it as the argument is equal to the object on which this method is invoked. By default, this means that two objects are stored in the same memory address.
public int hashCode() returns the hash code value of the object on which this method is invoked. The hash code must not change during one execution of the application but may change between executions.

Generate equals() and hashCode() for a class

In the main menu, go to Code and select Generate (Alt+Insert).
In the Generate popup, click equals() and hashCode().
Select a velocity template from the Template list.
You can also click to open the Templates dialog, where you can select an existing template or create a custom template.
Select an expression to generate within the method. Hover over the question mark icon to open a tooltip with an explanation of advantages and disadvantages of using each of the expressions.
Click Next.
Select the fields that should be used to determine equality, and click Next.
Select the fields to use for calculating the hash code value. You can choose only from fields that were selected on the previous step (for determining equality). Click Next.
Select the fields that contain non-null values. This optional step helps the generated code avoid checks for null and thus improves performance. Click Finish.

The following code fragment shows the result of overriding the equals() and hashCode() methods:

            public boolean equals(Object o){
                if(this==o)return true;
                if(o==null||getClass()!=o.getClass())return false;

                FixedRateCurrencyExchangeService that=(FixedRateCurrencyExchangeService)o;

                if(Double.compare(that.rate,rate)!=0)return false;

                return true;
            }

            public int hashCode(){
                long temp=rate!=+0.0d?Double.doubleToLongBits(rate):0L;
                return int(temp^(temp>>>32));
            }
        

Generate getters and setters

Aqua can generate accessor and mutator methods (getters and setters) for the fields in your classes. Generated methods have only one argument.

In the main menu, go to Code and select Generate (Alt+Insert).
In the Generate popup, click one of the following:
- Getter to generate accessor methods for getting the current values of class fields.
- Setter to generate mutator methods for setting the values of class fields.
- Getter and Setter to generate both accessor and mutator methods.
Select the fields to generate getters or setters for and click OK.
You can add a custom getter or setter method by clicking and accessing the Getter/Setter Templates dialog. If a field is not in the list, then the corresponding getter and setter methods are already defined for it.
If you select the Copy all annotations option, all applicable annotations from fields will be copied to new methods or to parameters of new methods. Otherwise, only applicable nullability annotations will be copied.

The following code fragment shows the result of generating the getter and setter methods for a class with one field var:

            public class MyClass {
                int field;

                public int getField() {
                    return field;
                }

                public void setField(int field) {
                    this.field = field;
                }
            }
        

Generate toString()

The toString() method of the Java super class java.lang.Object returns the string representation of the object. This method can be used to print any object to the standard output, for example, to quickly monitor the execution of your code. By default, toString() returns the name of the class followed by the hash code of the object. You can override it to return the values of the object's fields, for example, which can be more informative for your needs.

Override the toString() method for a class

On the Code menu, click Generate Alt+Insert.
In the Generate popup, click toString().
Configure the following:
- Select the template for generating the toString() method from the Template list.
- Select the fields that you want to return in the generated toString() method. By default, all the available fields are selected. Click Select None to generate a toString() method that returns only the class name.
- Select the Insert @Override checkbox if necessary.
- Click the Settings button to open the toString() Generation Settings dialog. where you can tune the behavior and add custom templates.
Click OK.

If the toString() method is already defined in the class, by default, you will be prompted whether you would like to delete this method before proceeding. You can use the When method already exists group of options in the toString() Generation Settings dialog to change this behavior: either automatically replace existing method or generate a duplicating method.

The following code fragment shows the result of generating the toString() method for a class with several fields defined:

            public class MyClass {
                private String name;
                private String url;
                private int port;
                private String[] validIPs;
                ...

                public String toString() {
                    return "MyClass{" +
                        "name='" + name + '\'' +
                        ", url='" + url + '\'' +
                        ", port=" + port +
                        ", validIps=" + Arrays.toString(validIps) +
                        '}';
                }
                ...
            }
        

The following code inspections are related to the toString() method:

Class does not override 'toString()' method can be used to identify classes in which the toString() method is not defined. This inspection uses the exclude settings to ignore classes with fields that are not supposed to be dumped. An additional setting is to exclude certain classes using a regular expression matching their class name. As default, this is used to exclude any exception classes.
Field not used in 'toString()' method can be used to identify fields that are not dumped in the toString() method. For example, if you added new fields to a class, but forgot to add them to the toString() method. Change the severity of this inspection to show errors as warnings. This will highlight any unused fields in the editor and indicate their location as yellow markers on the scroll bar.

Custom code generation templates

Templates used for generating getters and setters, as well as equals(), hashCode(), and toString() methods are written in the Velocity template language. Although you can't modify predefined templates, you can add your own custom templates to implement necessary behavior.

Aqua provides the following variables for Velocity templates:

The following variables can be used in templates for generating getters and setters:

Variable	Description
`$java_version`	The current version of the Java Runtime Environment (JRE).
`$class`	The current class.
`$helper`	Provides access to various code generation helper methods.
`$settings`	Provides the ability to format names according to the current code style.
`$field`	Field for which getter or setter is generated.

The following variables can be used in templates for generating the toString() method:

Variable	Description
`$java_version`	The current version of the Java Runtime Environment (JRE).
`$class`	The current class.
`$helper`	Provides access to various code generation helper methods.
`$settings`	Provides the ability to format names according to the current code style.
`$fields`	List of fields in the current class.

The following variables can be used in templates for generating the equals() method:

Variable	Description
`$java_version`	The current version of the Java Runtime Environment (JRE).
`$class`	The current class.
`$helper`	Provides access to various code generation helper methods.
`$settings`	Provides the ability to format names according to the current code style.
`$fields`	List of fields in the current class.
`$instanceBaseName`	Predefined name of the object on which the `equals()` method is called.
`$baseParamName`	Predefined name of the `equals()` method parameter.
`$superParamName`	The name of the parameter in the `equals()` method of the superclass if applicable.
`$checkParameterWithInstanceof`	Option passed from the wizard.
`$superHasEquals`	Whether the superclass has `equals()` declared.

The following variables can be used in templates for generating the hashCode() method:

Variable	Description
`$java_version`	The current version of the Java Runtime Environment (JRE).
`$class`	The current class.
`$helper`	Provides access to various code generation helper methods.
`$settings`	Provides the ability to format names according to the current code style.
`$fields`	List of fields in the current class.
`$superHasHashCode`	Whether the superclass has `hashCode()` declared.

Last modified: 08 November 2024