#958: Further clarify deprecation of TAG_CONTAINER_ARRAY

The commit expands on the deprecation reasoning for
PersistentDataType#TAG_CONTAINER_ARRAY to make it more clear for people
migrating their data as to why the data type is deprecated.

The commit also moves the annotation from obsolete to deprecated. The
special handling of this type in the pdc implementation is more annoying
than anything else and should not be used down the line, making
@Deprecated a more proper annotation for this field.
This commit is contained in:
Bjarne Koll 2024-01-14 12:54:25 +11:00 committed by md_5
parent ae21f4ace7
commit 70be76c7be
No known key found for this signature in database
GPG key ID: E8E901AC7C617C11

View file

@ -87,9 +87,11 @@ public interface PersistentDataType<P, C> {
Complex Arrays.
*/
/**
* @deprecated Use {@link #LIST}'s {@link ListPersistentDataTypeProvider#dataContainers()} instead.
* @deprecated Use {@link #LIST}'s {@link ListPersistentDataTypeProvider#dataContainers()} instead as
* {@link ListPersistentDataType}s offer full support for primitive types, such as the
* {@link PersistentDataContainer}.
*/
@ApiStatus.Obsolete
@Deprecated
PersistentDataType<PersistentDataContainer[], PersistentDataContainer[]> TAG_CONTAINER_ARRAY = new PrimitivePersistentDataType<>(PersistentDataContainer[].class);
/*