StateDescription constructor deprecated?

ppieczul · June 23, 2019, 8:08pm

Hello
I installed from scratch development environment with Eclipse IDE according to the latest guide on the web page and I noticed that it reports warnings for StateDescription constructors being deprecated. Same for mvn build. When I jump to the constructor in Eclipse, the file opens but there are no signs of deprecated annotations. Can someone help me explain why building reports these as deprecated? And how and which versions of the framework source files are loaded into eclipse, since they are not part of the working sets anymore.
Thanks
Pawel

cweitkamp · June 25, 2019, 2:42pm

Yes, I can. Because it is deprecated in favor of the new StateDescriptionFragmentBuilder:

github.com

openhab/openhab-core/blob/22937ae02feb7c060cc703d4276f6ee03201ac4e/bundles/org.openhab.core/src/main/java/org/eclipse/smarthome/core/types/StateDescription.java#L38-L58


      
          /**
           * Creates a state description object.
           *
           * @param minimum minimum value of the state
           * @param maximum maximum value of the state
           * @param step step size
           * @param pattern pattern to render the state
           * @param readOnly if the state can be changed by the system
           * @param options predefined list of options
           * @deprecated use {@link StateDescriptionFragmentBuilder} instead.
           */
          @Deprecated
          public StateDescription(@Nullable BigDecimal minimum, @Nullable BigDecimal maximum, @Nullable BigDecimal step,
                  @Nullable String pattern, boolean readOnly, @Nullable List<StateOption> options) {
              this.minimum = minimum;
              this.maximum = maximum;
              this.step = step;
              this.pattern = pattern;
              this.readOnly = readOnly;
              this.options = options == null ? Collections.emptyList() : Collections.unmodifiableList(options);
          }

ppieczul · June 25, 2019, 5:33pm

Thanks. This would mean the IDE pulls different sources for the framework than those used for compilation.

cweitkamp · June 25, 2019, 7:35pm

Did you erase your local .m2/ directory before setting up the new IDE? Maybe it tries to resolve outdated artifacts from over there.

ppieczul · June 26, 2019, 10:07pm

Indeed erasing .m2 and installing eclipse from scratch helped. Thanks! I can work on using the new StateDescriptionFragmentBuilder now.

ppieczul · June 27, 2019, 8:21pm

I took a look at the new suggested way of creating StateDescription with StateDescriptionFragmentBuilder. I use state descriptions to dynamically in runtime change channel description using a dynamic state description provider.

I suppose the new way to go would be: StateDescriptionFragmentBuilder.create().withXXX().build().toStateDescription()

This causes creation of 3 objects and copying their parameters from StateDescriptionFragmentBuilder to StateDescriptionFragment to StateDescription. As opposed to just creating StateDescription before.

Is this really the preferred way to go as it looks like a bit redundant?

Thanks
Pawel

tmrobert8 · June 28, 2019, 11:13am

They have been switching to builders for awhile. Personally, I prefer that since it insulates me from any changes to the underlying class (ie if they add something new, only the builder needs to change versus every bit of code that uses a constructor) and performance (to that degree) isn’t really an issue…

cweitkamp · June 28, 2019, 6:42pm

Yes, builders are the way to go.

Here you can find an explanation why it is called StateDescriptionFragmentBuilder and not StateDescriptionBuilder and why we have to convert from a to b and back.