Develop 0.2.0

[eggy03]

Description

This update introduces several breaking changes and is not backwards compatible with the previous versions.

Type of Change

Non-Breaking Changes

• Replaced the underlying mapper from GSON to Jackson
• Replaced DMIType.getCommand(int) with DMIType.getCommandFor(DMIType) in DMIType.java.
• Updated all service classes to use the new DMIType.getCommandFor() method.

Breaking Changes

• Removed all traces of Lombok and replaced them with Immutables equivalents for deep immutability of entity
  classes.
  As a result, the builder methods now have a slightly different syntax. The remaining changes involve writing more
  boilerplate code to make up for removal of Lombok's annotations but are non-breaking in nature.
  The complete list of changes can be found in the enclosed PR.

During Lombok, the syntax for an entity builder was as follows:

import io.github.eggy03.dmidecode.entity.processor.DMIProcessor;

void main() {
    // building a new entity using builder
    DMIProcessor processor = DMIProcessor.Builder.build();


    DMIProcessor processorTwo = processor.toBuilder().build();

    // accessing fields
    processor.getCurrentSpeed();
}

With Immutables, the new syntax is:

import io.github.eggy03.dmidecode.entity.processor.DMIProcessor;

@SuppressWarnings("all")
void main() {

    // building a new entity using builder
    DMIProcessor processor = new DMIProcessor.Builder().build();

    // updating a built entity
    DMIProcessor processorTwo = processor.withProperties();

    // accessing fields
    processor.currentSpeed();
}

• All entities have been converted to their abstract forms.
  Immutables handles their concrete implementation during compile time.
  This is technically not a breaking change since the generated implementations retain their pre-0.2.0 names

• CommonDMIMapper#mapToList returns an unmodifiable list using Collections.unmodifiableList

Test Changes

• Updated corresponding entity tests to use the Immutables builder pattern
• Updated MockEntityClass in CommonDMIMapperTest to use Jackson's @JsonProperty as a replacement for GSON's
  @SerializedValue.
• Removed all traces of Lombok from the tests.

Dependency Updates

• Added Jackson and Immutables BOMs and dependencies
• Removed GSON and Lombok
• Updated source generation plugins to support packing Immutables generated code in sources.jar
• Updated maven-compiler-plugin from 3.14.1 to 3.15.0
• Updated maven-surefire-plugin from 3.5.4 to 3.5.5
• Updated central-publishing-maven-plugin from 0.9.0 to 0.10.0
• Updated assertj-core from 3.27.6 to 3.27.7

Documentation

• Replaced JetBrains @NotNull and @Nullable and Lombok's @NonNull annotations with Jspecify equivalents.
  For @Unmodifiable, an equivalent custom @Unmodifiable annotation has been introduced.

• Introduced two new annotations @FragileMethod and @InvokesFragileMethod.
  These two annotations when used, document that a method or a constructor's implementation is fragile in nature
  and may break in the future.

• Updated Javadocs to reflect the Immutable builder style examples

• Removed @author tag from Javadocs

• Updated developer mail in pom.xml

• Corrected project.license.url branch from main to master in pom.xml

• Added an implementation status table in README.md

Related Issues

N/A