mirror of
https://github.com/IntellectualSites/PlotSquared.git
synced 2024-11-24 06:06:45 +01:00
Fill in 'since' annotations
This commit is contained in:
parent
a54276d3b2
commit
9885d3e506
@ -290,7 +290,7 @@ public class BukkitPlotGenerator extends ChunkGenerator implements GeneratorWrap
|
|||||||
*/
|
*/
|
||||||
@SuppressWarnings("deprecation") // The entire method is deprecated, but kept for compatibility with <=1.16.2
|
@SuppressWarnings("deprecation") // The entire method is deprecated, but kept for compatibility with <=1.16.2
|
||||||
@Override
|
@Override
|
||||||
@Deprecated(since = "TODO")
|
@Deprecated(since = "7.0.0")
|
||||||
public @NonNull ChunkData generateChunkData(
|
public @NonNull ChunkData generateChunkData(
|
||||||
@NonNull World world, @NonNull Random random, int x, int z, @NonNull BiomeGrid biome
|
@NonNull World world, @NonNull Random random, int x, int z, @NonNull BiomeGrid biome
|
||||||
) {
|
) {
|
||||||
|
@ -32,7 +32,7 @@ import java.util.stream.Stream;
|
|||||||
* MiniMessage changed the syntax between major releases. To warrant a smooth upgrade, we attempt to replace any occurrences
|
* MiniMessage changed the syntax between major releases. To warrant a smooth upgrade, we attempt to replace any occurrences
|
||||||
* while loading PlotSquared.
|
* while loading PlotSquared.
|
||||||
*
|
*
|
||||||
* @since TODO
|
* @since 7.0.0
|
||||||
*/
|
*/
|
||||||
@NotPublic
|
@NotPublic
|
||||||
public class TranslationUpdateManager {
|
public class TranslationUpdateManager {
|
||||||
|
@ -40,7 +40,7 @@ public interface Caption {
|
|||||||
*
|
*
|
||||||
* @param localeHolder Locale holder
|
* @param localeHolder Locale holder
|
||||||
* @return {@link ComponentLike}
|
* @return {@link ComponentLike}
|
||||||
* @since TODO
|
* @since 7.0.0
|
||||||
*/
|
*/
|
||||||
@NonNull Component toComponent(@NonNull LocaleHolder localeHolder);
|
@NonNull Component toComponent(@NonNull LocaleHolder localeHolder);
|
||||||
|
|
||||||
|
@ -51,7 +51,7 @@ public class CaptionHolder {
|
|||||||
* Get the {@link TagResolver}s to use when resolving tags in the {@link Caption}.
|
* Get the {@link TagResolver}s to use when resolving tags in the {@link Caption}.
|
||||||
*
|
*
|
||||||
* @return The tag resolvers to use.
|
* @return The tag resolvers to use.
|
||||||
* @since TODO
|
* @since 7.0.0
|
||||||
*/
|
*/
|
||||||
public TagResolver[] getTagResolvers() {
|
public TagResolver[] getTagResolvers() {
|
||||||
return this.tagResolvers;
|
return this.tagResolvers;
|
||||||
@ -61,7 +61,7 @@ public class CaptionHolder {
|
|||||||
* Set the {@link TagResolver}s to use when resolving tags in the {@link Caption}.
|
* Set the {@link TagResolver}s to use when resolving tags in the {@link Caption}.
|
||||||
*
|
*
|
||||||
* @param tagResolvers The tag resolvers to use.
|
* @param tagResolvers The tag resolvers to use.
|
||||||
* @since TODO
|
* @since 7.0.0
|
||||||
*/
|
*/
|
||||||
public void setTagResolvers(TagResolver... tagResolvers) {
|
public void setTagResolvers(TagResolver... tagResolvers) {
|
||||||
this.tagResolvers = tagResolvers;
|
this.tagResolvers = tagResolvers;
|
||||||
|
@ -46,7 +46,7 @@ public abstract class IndependentPlotGenerator {
|
|||||||
* @param result Queue to write to
|
* @param result Queue to write to
|
||||||
* @param settings PlotArea (settings)
|
* @param settings PlotArea (settings)
|
||||||
* @param biomes If biomes should be generated
|
* @param biomes If biomes should be generated
|
||||||
* @since TODO
|
* @since 7.0.0
|
||||||
*/
|
*/
|
||||||
public abstract void generateChunk(ZeroedDelegateScopedQueueCoordinator result, PlotArea settings, boolean biomes);
|
public abstract void generateChunk(ZeroedDelegateScopedQueueCoordinator result, PlotArea settings, boolean biomes);
|
||||||
|
|
||||||
@ -55,7 +55,7 @@ public abstract class IndependentPlotGenerator {
|
|||||||
*
|
*
|
||||||
* @param result Queue to write to
|
* @param result Queue to write to
|
||||||
* @param setting PlotArea (settings)
|
* @param setting PlotArea (settings)
|
||||||
* @since TODO
|
* @since 7.0.0
|
||||||
*/
|
*/
|
||||||
public void populateChunk(ZeroedDelegateScopedQueueCoordinator result, PlotArea setting) {
|
public void populateChunk(ZeroedDelegateScopedQueueCoordinator result, PlotArea setting) {
|
||||||
}
|
}
|
||||||
@ -108,7 +108,7 @@ public abstract class IndependentPlotGenerator {
|
|||||||
* @param y World y position
|
* @param y World y position
|
||||||
* @param z World z position
|
* @param z World z position
|
||||||
* @return Biome type to be generated
|
* @return Biome type to be generated
|
||||||
* @since TODO
|
* @since 7.0.0
|
||||||
*/
|
*/
|
||||||
public abstract BiomeType getBiome(PlotArea settings, int x, int y, int z);
|
public abstract BiomeType getBiome(PlotArea settings, int x, int y, int z);
|
||||||
|
|
||||||
|
@ -88,7 +88,7 @@ public abstract class PlotFlag<T, F extends PlotFlag<T, F>> {
|
|||||||
* Gets the flag name as a Kyori {@link Component}
|
* Gets the flag name as a Kyori {@link Component}
|
||||||
*
|
*
|
||||||
* @see #getFlagName(Class)
|
* @see #getFlagName(Class)
|
||||||
* @since TODO
|
* @since 7.0.0
|
||||||
*/
|
*/
|
||||||
public static <T, F extends PlotFlag<T, F>> Component getFlagNameComponent(Class<F> flagClass) {
|
public static <T, F extends PlotFlag<T, F>> Component getFlagNameComponent(Class<F> flagClass) {
|
||||||
return Component.text(getFlagName(flagClass));
|
return Component.text(getFlagName(flagClass));
|
||||||
|
@ -111,7 +111,7 @@ public interface PlotAreaManager {
|
|||||||
*
|
*
|
||||||
* @param worldName Name of the world to add
|
* @param worldName Name of the world to add
|
||||||
* @return {@code true} if successful, {@code false} if world already existed
|
* @return {@code true} if successful, {@code false} if world already existed
|
||||||
* @since TODO
|
* @since 7.0.0
|
||||||
*/
|
*/
|
||||||
boolean addWorld(@NonNull String worldName);
|
boolean addWorld(@NonNull String worldName);
|
||||||
|
|
||||||
|
@ -66,7 +66,7 @@ public abstract class QueueCoordinator {
|
|||||||
* @param x chunk x coordinate
|
* @param x chunk x coordinate
|
||||||
* @param z chunk z coordinate
|
* @param z chunk z coordinate
|
||||||
* @return a new {@link ZeroedDelegateScopedQueueCoordinator}
|
* @return a new {@link ZeroedDelegateScopedQueueCoordinator}
|
||||||
* @since TODO
|
* @since 7.0.0
|
||||||
*/
|
*/
|
||||||
public ZeroedDelegateScopedQueueCoordinator getForChunk(int x, int z, int minY, int maxY) {
|
public ZeroedDelegateScopedQueueCoordinator getForChunk(int x, int z, int minY, int maxY) {
|
||||||
int bx = x << 4;
|
int bx = x << 4;
|
||||||
|
@ -32,7 +32,7 @@ import org.checkerframework.checker.nullness.qual.Nullable;
|
|||||||
* zero in the x and z directions, i.e. starting from 0,0. An offset of the minimum point of the region will then be applied to
|
* zero in the x and z directions, i.e. starting from 0,0. An offset of the minimum point of the region will then be applied to
|
||||||
* x and z.
|
* x and z.
|
||||||
*
|
*
|
||||||
* @since TODO
|
* @since 7.0.0
|
||||||
*/
|
*/
|
||||||
public class ZeroedDelegateScopedQueueCoordinator extends DelegateQueueCoordinator {
|
public class ZeroedDelegateScopedQueueCoordinator extends DelegateQueueCoordinator {
|
||||||
|
|
||||||
@ -50,7 +50,7 @@ public class ZeroedDelegateScopedQueueCoordinator extends DelegateQueueCoordinat
|
|||||||
/**
|
/**
|
||||||
* Create a new ScopedQueueCoordinator instance that delegates to a given QueueCoordinator. Locations are inclusive.
|
* Create a new ScopedQueueCoordinator instance that delegates to a given QueueCoordinator. Locations are inclusive.
|
||||||
*
|
*
|
||||||
* @since TODO
|
* @since 7.0.0
|
||||||
*/
|
*/
|
||||||
public ZeroedDelegateScopedQueueCoordinator(@Nullable QueueCoordinator parent, @NonNull Location min, @NonNull Location max) {
|
public ZeroedDelegateScopedQueueCoordinator(@Nullable QueueCoordinator parent, @NonNull Location min, @NonNull Location max) {
|
||||||
super(parent);
|
super(parent);
|
||||||
|
@ -36,7 +36,7 @@ public abstract class ChunkManager {
|
|||||||
private static final Map<BlockVector2, RunnableVal<ZeroedDelegateScopedQueueCoordinator>> addChunks = new ConcurrentHashMap<>();
|
private static final Map<BlockVector2, RunnableVal<ZeroedDelegateScopedQueueCoordinator>> addChunks = new ConcurrentHashMap<>();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @since TODO
|
* @since 7.0.0
|
||||||
*/
|
*/
|
||||||
public static void setChunkInPlotArea(
|
public static void setChunkInPlotArea(
|
||||||
RunnableVal<ZeroedDelegateScopedQueueCoordinator> force,
|
RunnableVal<ZeroedDelegateScopedQueueCoordinator> force,
|
||||||
@ -76,7 +76,7 @@ public abstract class ChunkManager {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @since TODO
|
* @since 7.0.0
|
||||||
*/
|
*/
|
||||||
public static boolean preProcessChunk(BlockVector2 loc, ZeroedDelegateScopedQueueCoordinator queue) {
|
public static boolean preProcessChunk(BlockVector2 loc, ZeroedDelegateScopedQueueCoordinator queue) {
|
||||||
final RunnableVal<ZeroedDelegateScopedQueueCoordinator> forceChunk = forceChunks.get(loc);
|
final RunnableVal<ZeroedDelegateScopedQueueCoordinator> forceChunk = forceChunks.get(loc);
|
||||||
@ -89,7 +89,7 @@ public abstract class ChunkManager {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @since TODO
|
* @since 7.0.0
|
||||||
*/
|
*/
|
||||||
public static boolean postProcessChunk(BlockVector2 loc, ZeroedDelegateScopedQueueCoordinator queue) {
|
public static boolean postProcessChunk(BlockVector2 loc, ZeroedDelegateScopedQueueCoordinator queue) {
|
||||||
final RunnableVal<ZeroedDelegateScopedQueueCoordinator> addChunk = forceChunks.get(loc);
|
final RunnableVal<ZeroedDelegateScopedQueueCoordinator> addChunk = forceChunks.get(loc);
|
||||||
|
@ -27,7 +27,7 @@ import java.util.Collection;
|
|||||||
/**
|
/**
|
||||||
* A utility class for modifying components.
|
* A utility class for modifying components.
|
||||||
*
|
*
|
||||||
* @since TODO
|
* @since 7.0.0
|
||||||
*/
|
*/
|
||||||
public class ComponentHelper {
|
public class ComponentHelper {
|
||||||
|
|
||||||
@ -37,7 +37,7 @@ public class ComponentHelper {
|
|||||||
* @param components The components to join
|
* @param components The components to join
|
||||||
* @param delimiter The delimiter to use between the components
|
* @param delimiter The delimiter to use between the components
|
||||||
* @return The joined components
|
* @return The joined components
|
||||||
* @since TODO
|
* @since 7.0.0
|
||||||
*/
|
*/
|
||||||
public static ComponentLike join(Collection<? extends ComponentLike> components, Component delimiter) {
|
public static ComponentLike join(Collection<? extends ComponentLike> components, Component delimiter) {
|
||||||
return join(components.toArray(ComponentLike[]::new), delimiter);
|
return join(components.toArray(ComponentLike[]::new), delimiter);
|
||||||
@ -49,7 +49,7 @@ public class ComponentHelper {
|
|||||||
* @param components The components to join
|
* @param components The components to join
|
||||||
* @param delimiter The delimiter to use between the components
|
* @param delimiter The delimiter to use between the components
|
||||||
* @return The joined components
|
* @return The joined components
|
||||||
* @since TODO
|
* @since 7.0.0
|
||||||
*/
|
*/
|
||||||
public static Component join(ComponentLike[] components, Component delimiter) {
|
public static Component join(ComponentLike[] components, Component delimiter) {
|
||||||
TextComponent.Builder builder = Component.text();
|
TextComponent.Builder builder = Component.text();
|
||||||
|
Loading…
Reference in New Issue
Block a user