JEFF Media Developer Blog

Java & Spigot development

Menu
  • Blog
  • Main Website
  • Privacy Policy
Menu

Data classes using Records or Lombok

Posted on August 8, 2021August 8, 2021 by mfnalex

Data classes are your way to go when you want to store information, but they have been very tedious to create.

The problem

Imagine you have a simple data class called Cuboid that describes a geomatrical cuboid. It gets defined by three doubles:

  • Width, called sizeX
  • Height, called sizeY
  • Depth, called sizeZ

Of course our Cuboid should also implement the equals, hashCode and toString methods.

Normally, we would now go ahead and write this:

import java.util.Objects;

public class Cuboid {
    private final double sizeX;
    private final double sizeY;
    private final double sizeZ;

    public Cuboid(double sizeX, double sizeY, double sizeZ) {
        this.sizeX = sizeX;
        this.sizeY = sizeY;
        this.sizeZ = sizeZ;
    }

    public double getSizeX() {
        return sizeX;
    }

    public double getSizeY() {
        return sizeY;
    }

    public double getSizeZ() {
        return sizeZ;
    }

    @Override
    public String toString() {
        return "Cuboid{" +
                "sizeX=" + sizeX +
                ", sizeY=" + sizeY +
                ", sizeZ=" + sizeZ +
                '}';
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        Cuboid cuboid = (Cuboid) o;
        return Double.compare(cuboid.sizeX, sizeX) == 0 && Double.compare(cuboid.sizeY, sizeY) == 0 && Double.compare(cuboid.sizeZ, sizeZ) == 0;
    }

    @Override
    public int hashCode() {
        return Objects.hash(sizeX, sizeY, sizeZ);
    }
}

That’s 47(!) lines just for a tiny data class that doesn’t do anything besides storing 3 double values…

Solution 1 (Java 15+): Record classes

Java 15 introduced a new awesome feature called Records. By using them, we can narrow the complete code down to only one line:

public record Cuboid(double sizeX, double sizeY, double sizeZ) { }

Java automatically provides all methods that we had to implement ourselves in the above code! The only difference is that the getters are not called getSizeX() etc, but are simply called sizeX().

Solution 2: Lombok

When you cannot use Records because your users are still running Minecraft 1.8 (WTF) or didn’t update to Java 15+ yet, you can use the Lombok framework instead.

Just add Lombok to your project, e.g. when using maven:

<dependency>
	<groupId>org.projectlombok</groupId>
	<artifactId>lombok</artifactId>
	<version>1.18.20</version>
	<scope>provided</scope>
</dependency>

Now we can simply annotate our class with the @Data annotation:

import lombok.Data;

@Data
public class Cuboid {
    private final double sizeX;
    private final double sizeY;
    private final double sizeZ;
}

Once again, we got rid of defining constructors, getters and the hashCode, toString and equals method! Lombok will automatically generate all this stuff for you!

You can learn more about Lombok here – it has many other awesome features!

Join my Discord Server for feedback or support. Just check out the channel #programming-help 🙂

Leave a Reply Cancel reply

Your email address will not be published. Required fields are marked *

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.

Recent Posts

  • Why IntelliJ complains about your pom.xml file
  • How to make maven automatically put your plugin’s .jar into your test server’s plugins folder
  • Use Consumers when spawning custom entities
  • Java’s init blocks
  • Bukkit vs. Spigot-API vs. CraftBukkit vs. Spigot

Recent Comments

  1. mfnalex on NMS: Use Mojang mappings for your Spigot plugins with Maven
  2. fisher on NMS: Use Mojang mappings for your Spigot plugins with Maven
  3. stromectol no prescription on Obfuscate plugins using allatori
  4. pharmacy uk on Obfuscate plugins using allatori
  5. mfnalex on Obfuscate plugins using allatori

Archives

  • February 2023
  • January 2023
  • October 2022
  • August 2022
  • March 2022
  • December 2021
  • October 2021
  • August 2021
©2023 JEFF Media Developer Blog
We use cookies on our website to give you the most relevant experience by remembering your preferences and repeat visits. By clicking “Accept All”, you consent to the use of ALL the cookies. However, you may visit "Cookie Settings" to provide a controlled consent.
Cookie SettingsAccept All
Manage consent

Privacy Overview

This website uses cookies to improve your experience while you navigate through the website. Out of these, the cookies that are categorized as necessary are stored on your browser as they are essential for the working of basic functionalities of the website. We also use third-party cookies that help us analyze and understand how you use this website. These cookies will be stored in your browser only with your consent. You also have the option to opt-out of these cookies. But opting out of some of these cookies may affect your browsing experience.
Necessary
Always Enabled
Necessary cookies are absolutely essential for the website to function properly. These cookies ensure basic functionalities and security features of the website, anonymously.
CookieDurationDescription
cookielawinfo-checkbox-analytics11 monthsThis cookie is set by GDPR Cookie Consent plugin. The cookie is used to store the user consent for the cookies in the category "Analytics".
cookielawinfo-checkbox-functional11 monthsThe cookie is set by GDPR cookie consent to record the user consent for the cookies in the category "Functional".
cookielawinfo-checkbox-necessary11 monthsThis cookie is set by GDPR Cookie Consent plugin. The cookies is used to store the user consent for the cookies in the category "Necessary".
cookielawinfo-checkbox-others11 monthsThis cookie is set by GDPR Cookie Consent plugin. The cookie is used to store the user consent for the cookies in the category "Other.
cookielawinfo-checkbox-performance11 monthsThis cookie is set by GDPR Cookie Consent plugin. The cookie is used to store the user consent for the cookies in the category "Performance".
viewed_cookie_policy11 monthsThe cookie is set by the GDPR Cookie Consent plugin and is used to store whether or not user has consented to the use of cookies. It does not store any personal data.
Functional
Functional cookies help to perform certain functionalities like sharing the content of the website on social media platforms, collect feedbacks, and other third-party features.
Performance
Performance cookies are used to understand and analyze the key performance indexes of the website which helps in delivering a better user experience for the visitors.
Analytics
Analytical cookies are used to understand how visitors interact with the website. These cookies help provide information on metrics the number of visitors, bounce rate, traffic source, etc.
Advertisement
Advertisement cookies are used to provide visitors with relevant ads and marketing campaigns. These cookies track visitors across websites and collect information to provide customized ads.
Others
Other uncategorized cookies are those that are being analyzed and have not been classified into a category as yet.
SAVE & ACCEPT