@@ -195,7 +196,7 @@ public Side reduce() { /** * Shorthand for {@code Side.assertSide(this)} * - * @see #assertSide(Side) + * @see #assertSide(nova.core.network.NetworkTarget.Side) */ public void assertSide() { Side current = get(); diff --git a/src/main/java/nova/core/network/Packet.java b/src/main/java/nova/core/network/Packet.java index 2ad0c0484..16bf40ec1 100644 --- a/src/main/java/nova/core/network/Packet.java +++ b/src/main/java/nova/core/network/Packet.java @@ -47,12 +47,14 @@ public interface Packet { /** * Sets the ID of this packet, allowing it to be sent accordingly. + * @param id The packet ID * @return The packet itself. */ Packet setID(int id); /** * The player sending the packet + * @return The player sending the packet */ Player player(); @@ -193,7 +195,7 @@ default Packet write(Object data) { Packet writeString(String value); //TODO: Packet handler is bad at reading/writing enums for unknown reasons - default Packet writeEnum(Enum data) { + default Packet writeEnum(Enum data) { writeString(data.getClass().getName()); writeString(data.name()); return this; @@ -232,7 +234,7 @@ default Packet writeStorable(Storable storable) { return this; } - default Packet writeCollection(Collection col) { + default Packet writeCollection(Collection col) { writeInt(col.size()); col.forEach(obj -> { writeShort(getType(obj.getClass())); @@ -241,7 +243,7 @@ default Packet writeCollection(Collection col) { return this; } - default Packet writeOptional(Optional optional) { + default Packet writeOptional(Optional optional) { if (optional.isPresent()) { writeShort(getType(optional.get().getClass())); write(optional.get()); @@ -337,17 +339,18 @@ default Packet writeOptional(Optional optional) { String readString(); - default Enum readEnum() { + default > E readEnum() { try { String enumClassName = readString(); - Class className = (Class) Class.forName(enumClassName); + @SuppressWarnings("unchecked") + Class className = (Class) Class.forName(enumClassName); return readEnum(className); } catch (Exception e) { throw new NetworkException("Failed to read enum.", e); } } - default Enum readEnum(Class type) { + default > E readEnum(Class type) { return Enum.valueOf(type, readString()); } @@ -358,6 +361,7 @@ default Syncable readPacketHandler(Syncable handler) { /** * Reads a {@link Data} type. + * @return The data type */ default Data readData() { Data readData = new Data(); @@ -380,13 +384,14 @@ default Object readStorable() { } default List readList() { - ArrayList arrayList = new ArrayList(); + ArrayList arrayList = new ArrayList<>(); int size = readInt(); IntStream .range(0, size) .forEach(i -> { short type = readShort(); + @SuppressWarnings("unchecked") T value = (T) read(Data.dataTypes[type]); arrayList.add(value); }); @@ -402,6 +407,7 @@ default Set readSet() { .range(0, size) .forEach(i -> { short type = readShort(); + @SuppressWarnings("unchecked") T value = (T) read(Data.dataTypes[type]); set.add(value); }); @@ -409,6 +415,7 @@ default Set readSet() { return set; } + @SuppressWarnings("unchecked") default Optional readOptional() { short type = readShort(); if (type != -1) { @@ -426,6 +433,7 @@ default Vector3D readVector3D() { return new Vector3D(readDouble(), readDouble(), readDouble()); } + @SuppressWarnings("unchecked") default T read(Class clazz) { if (clazz == Boolean.class || clazz == boolean.class) { return (T) Boolean.valueOf(readBoolean()); diff --git a/src/main/java/nova/core/recipes/ingredient/ItemIngredient.java b/src/main/java/nova/core/recipes/ingredient/ItemIngredient.java index 9c37547f1..a86c320d4 100755 --- a/src/main/java/nova/core/recipes/ingredient/ItemIngredient.java +++ b/src/main/java/nova/core/recipes/ingredient/ItemIngredient.java @@ -118,8 +118,10 @@ static ItemIngredient forDictionary(String id) { Optional getTag(); /** - * Sets the ingredient tag. Ingredients can be tagged to make them easy to read from recipe functions. + * Sets the ingredient tag. Ingredients can be tagged to make them + * easy to read from recipe functions. * + * @param tag The ingredient tag * @return this instance */ public ItemIngredient withTag(String tag); diff --git a/src/main/java/nova/core/render/RenderException.java b/src/main/java/nova/core/render/RenderException.java index 8c6302c5e..a2c02138e 100644 --- a/src/main/java/nova/core/render/RenderException.java +++ b/src/main/java/nova/core/render/RenderException.java @@ -23,6 +23,8 @@ import nova.core.util.exception.NovaException; public class RenderException extends NovaException { + private static final long serialVersionUID = 1L; + public RenderException() { super(); } diff --git a/src/main/java/nova/core/render/pipeline/BlockRenderPipeline.java b/src/main/java/nova/core/render/pipeline/BlockRenderPipeline.java index 2873a8909..a6f4f7d6a 100644 --- a/src/main/java/nova/core/render/pipeline/BlockRenderPipeline.java +++ b/src/main/java/nova/core/render/pipeline/BlockRenderPipeline.java @@ -138,7 +138,7 @@ public BlockRenderPipeline withBounds(Cuboid bounds) { * * @param renderSide A predicate that takes a {@link nova.core.util.Direction} * and returns a boolean specifying whether or not the side should render. - * @return + * @return this */ public BlockRenderPipeline filter(Predicate renderSide) { this.renderSide = renderSide; diff --git a/src/main/java/nova/core/render/pipeline/ItemRenderPipeline.java b/src/main/java/nova/core/render/pipeline/ItemRenderPipeline.java index a1f915d4e..9af5a1ee4 100644 --- a/src/main/java/nova/core/render/pipeline/ItemRenderPipeline.java +++ b/src/main/java/nova/core/render/pipeline/ItemRenderPipeline.java @@ -43,7 +43,7 @@ */ public class ItemRenderPipeline extends RenderPipeline { - public final ComponentProvider componentProvider; + public final ComponentProvider componentProvider; /** * Called to get the texture of this item. @@ -64,7 +64,7 @@ public class ItemRenderPipeline extends RenderPipeline { */ public Supplier colorMultiplier = () -> Color.white; - public ItemRenderPipeline(ComponentProvider componentProvider) { + public ItemRenderPipeline(ComponentProvider componentProvider) { this.componentProvider = componentProvider; size = () -> new Vector2D(1, 1); consumer = model -> model.addChild(draw(new MeshModel())); diff --git a/src/main/java/nova/core/retention/Data.java b/src/main/java/nova/core/retention/Data.java index 1429771ff..a93fbeb02 100755 --- a/src/main/java/nova/core/retention/Data.java +++ b/src/main/java/nova/core/retention/Data.java @@ -219,11 +219,12 @@ public static T unserialize(Data data) { * Loads an object from its stored data, given its class. * @param clazz - The class to load * @param data - The data + * @param - The type * @return The object loaded with given data. */ public static T unserialize(Class clazz, Data data) { try { - T storable = clazz.newInstance(); + T storable = clazz.getDeclaredConstructor().newInstance(); storable.load(data); return storable; } catch (Exception e) { @@ -324,7 +325,7 @@ public T getStorable(String key) { try { @SuppressWarnings("unchecked") Class storableClass = (Class) Class.forName(storableData.className); - T obj = storableClass.newInstance(); + T obj = storableClass.getDeclaredConstructor().newInstance(); obj.load(storableData); return obj; } catch (Exception e) { diff --git a/src/main/java/nova/core/retention/Storable.java b/src/main/java/nova/core/retention/Storable.java index 3efa05639..28a0e3a7a 100644 --- a/src/main/java/nova/core/retention/Storable.java +++ b/src/main/java/nova/core/retention/Storable.java @@ -88,7 +88,7 @@ default void load(Data data) { if (List.class.isAssignableFrom(type)) { field.set(this, Data.unserialize((Data) value)); } else { - Collection collection = (Collection) type.newInstance(); + Collection collection = (Collection) type.getDeclaredConstructor().newInstance(); field.set(this, collection.addAll(Data.unserialize((Data) value))); } } else { diff --git a/src/main/java/nova/core/util/ClassLoaderUtil.java b/src/main/java/nova/core/util/ClassLoaderUtil.java index c3e4a8e1b..b9dffb23a 100644 --- a/src/main/java/nova/core/util/ClassLoaderUtil.java +++ b/src/main/java/nova/core/util/ClassLoaderUtil.java @@ -61,6 +61,8 @@ private static synchronized void setAddURL() { } public static class ClassLoaderException extends NovaException { + private static final long serialVersionUID = 1L; + public ClassLoaderException() { super(); } diff --git a/src/main/java/nova/core/util/EnumSelector.java b/src/main/java/nova/core/util/EnumSelector.java index a557110b8..40ca597b2 100644 --- a/src/main/java/nova/core/util/EnumSelector.java +++ b/src/main/java/nova/core/util/EnumSelector.java @@ -52,6 +52,8 @@ private EnumSelector(Class enumClass) { /** * Creates a new instance of EnumSelector for the given type. * + * @param The enum type + * @param enumClass The enum class for which to create an EnumSelector. * @return an instance of EnumSelector for the given type. */ public static > EnumSelector of(Class enumClass) { diff --git a/src/main/java/nova/core/util/Pipeline.java b/src/main/java/nova/core/util/Pipeline.java index dd8da422e..18cfc390a 100644 --- a/src/main/java/nova/core/util/Pipeline.java +++ b/src/main/java/nova/core/util/Pipeline.java @@ -6,6 +6,7 @@ /** * A series of methods that transform an object as it is passed through the {@link Pipeline}. * @author Calclavia + * @param The pipeline type. */ public class Pipeline { protected Optional> prev = Optional.empty(); @@ -29,6 +30,7 @@ public Pipeline(Consumer consumer) { /** * Sets the given pipeline to be piped after this render stream. * This method essentially allow you to switch between processes in the pipeline. + * @param The new pipeline type. * @param stream The stream to apply. * @return The new RenderStream */ diff --git a/src/main/java/nova/core/util/ProgressBar.java b/src/main/java/nova/core/util/ProgressBar.java index 6d5b68c9e..12239f69a 100644 --- a/src/main/java/nova/core/util/ProgressBar.java +++ b/src/main/java/nova/core/util/ProgressBar.java @@ -58,6 +58,8 @@ protected void stepImpl(String message) {} /** * Check if the progress bar has been finished. + * + * @return If the progress bar has finished. */ boolean isFinished(); diff --git a/src/main/java/nova/core/util/RayTracer.java b/src/main/java/nova/core/util/RayTracer.java index 79ac4d66e..69e4312f5 100644 --- a/src/main/java/nova/core/util/RayTracer.java +++ b/src/main/java/nova/core/util/RayTracer.java @@ -89,6 +89,7 @@ public Stream rayTraceAll(World world) { /** * Check all blocks that are in a line + * @param world The world to perform the ray trace in. * @return The blocks ray traced in the order from closest to furthest. */ public Stream rayTraceBlocks(World world) { @@ -171,7 +172,9 @@ public Optional rayTrace(Cuboid cuboid) { /** * Ray traces a cuboid + * @param the result type * @param cuboid The cuboid in absolute world coordinates + * @param resultMapper the {@link RayTraceResult} converter * @return The ray trace result if the ray intersects the cuboid */ public Optional rayTrace(Cuboid cuboid, BiFunction resultMapper) { diff --git a/src/main/java/nova/core/util/ReflectionUtil.java b/src/main/java/nova/core/util/ReflectionUtil.java index 4ffb81317..47c7a104c 100644 --- a/src/main/java/nova/core/util/ReflectionUtil.java +++ b/src/main/java/nova/core/util/ReflectionUtil.java @@ -267,7 +267,7 @@ public static T newInstanceMatching(Class clazz, Object... args) { if (args != null && args.length > 0) { return newInstanceMatching(findMatchingConstructor(clazz, types(args)).get(), args); } else { - return clazz.newInstance(); + return clazz.getDeclaredConstructor().newInstance(); } } catch (Exception e) { throw new ReflectionException(e); @@ -279,7 +279,7 @@ public static T newInstance(Class clazz, Object... args) { if (args != null && args.length > 0) { return clazz.getConstructor(types(args)).newInstance(args); } - return clazz.newInstance(); + return clazz.getDeclaredConstructor().newInstance(); } catch (Exception e) { throw new ReflectionException(e); } @@ -304,6 +304,7 @@ public static void forEachAnnotatedField(Class The annotation type * @param annotation Your annotation class. * @param clazz Class to search through. * @return An ordered map of annotated fields and their annotations from the @@ -329,6 +330,8 @@ public static void forEachRecursiveAnnotatedField(Class Type contained in the list */ public class EvictingList extends LinkedList { + private static final long serialVersionUID = 1L; + private final int limit; /** diff --git a/src/main/java/nova/core/util/collection/TreeNode.java b/src/main/java/nova/core/util/collection/TreeNode.java index 3a7b610cd..b63839889 100644 --- a/src/main/java/nova/core/util/collection/TreeNode.java +++ b/src/main/java/nova/core/util/collection/TreeNode.java @@ -36,7 +36,7 @@ * * @param - Self type */ -public class TreeNode implements Iterable { +public class TreeNode> implements Iterable { /** * The children of the node. @@ -71,9 +71,10 @@ public void setParent(Optional parent) { * @param node The childnode to add * @return The merged node */ + @SuppressWarnings("unchecked") public S addChild(S node) { children.add(node); - node.parent = Optional.of(this); + node.parent = Optional.of((S) this); return node; } diff --git a/src/main/java/nova/core/util/exception/RegistrationException.java b/src/main/java/nova/core/util/exception/RegistrationException.java index 320470054..6daa8bc63 100644 --- a/src/main/java/nova/core/util/exception/RegistrationException.java +++ b/src/main/java/nova/core/util/exception/RegistrationException.java @@ -24,6 +24,8 @@ * An exception thrown when registration in a manager, dictionary or registry fails. */ public class RegistrationException extends NovaException { + private static final long serialVersionUID = 1L; + public RegistrationException() { super(); } diff --git a/src/main/java/nova/core/util/math/MatrixStack.java b/src/main/java/nova/core/util/math/MatrixStack.java index de9db256f..addd37d89 100755 --- a/src/main/java/nova/core/util/math/MatrixStack.java +++ b/src/main/java/nova/core/util/math/MatrixStack.java @@ -42,8 +42,8 @@ public MatrixStack() { * Clone construcotr of MatrixStack * @param clone instance to be cloned */ + @SuppressWarnings("unchecked") public MatrixStack(MatrixStack clone) { - //noinspection unchecked this.stack = (Stack) clone.stack.clone(); this.current = clone.current.copy(); } diff --git a/src/main/java/nova/core/util/math/MatrixUtil.java b/src/main/java/nova/core/util/math/MatrixUtil.java index a4fbbeea7..8bf86032e 100755 --- a/src/main/java/nova/core/util/math/MatrixUtil.java +++ b/src/main/java/nova/core/util/math/MatrixUtil.java @@ -55,6 +55,8 @@ public static RealMatrix augmentWithIdentity(RealMatrix matrix, int dimensions) // Little cheat. private static Localizable of(String string) { return new Localizable() { + private static final long serialVersionUID = 1L; + @Override public String getSourceString() { return string; diff --git a/src/main/java/nova/core/util/math/RotationUtil.java b/src/main/java/nova/core/util/math/RotationUtil.java index eac0e92b4..45e9b1359 100755 --- a/src/main/java/nova/core/util/math/RotationUtil.java +++ b/src/main/java/nova/core/util/math/RotationUtil.java @@ -79,7 +79,10 @@ public static int rotateSide(int s, int r) { } /** - * Reverse of rotateSide + * Rotates a Direction global size into a relative side. + * @param s1 Side 1 + * @param s2 Side 2 + * @return The Direction ordinal from 0-5. */ public static int rotationTo(int s1, int s2) { if ((s1 & 6) == (s2 & 6)) { @@ -106,6 +109,11 @@ public static Direction getRelativeSide(Direction front, Direction side) { * Wrapper function that simply calls {@code slerp(a, b, t, true)}. * * See {@link #slerp(Rotation, Rotation, double, boolean)} for details. + * + * @param a the first Rotation + * @param b the second Rotation + * @param t the temporal interpolation parameter + * @return The slerp interpolation of Rotations {@code a} and {@code b}, at time {@code t}. */ public static Rotation slerp(Rotation a, Rotation b, double t) { return slerp(a, b, t, true); @@ -123,11 +131,12 @@ public static Rotation slerp(Rotation a, Rotation b, double t) { * "flipping" the source Rotation if needed. * @param a the first Rotation * @param b the second Rotation - * @param t the t interpolation parameter + * @param t the temporal interpolation parameter * @param allowFlip tells whether or not the interpolation allows axis flip + * @return The slerp interpolation of Rotations {@code a} and {@code b}, at time {@code t}. */ public static Rotation slerp(Rotation a, Rotation b, double t, boolean allowFlip) { - // Warning: this method should not normalize the Rotation + // TODO: this method should not normalize the Rotation double cosAngle = dotProduct(a, b); double c1, c2; @@ -156,7 +165,9 @@ public static Rotation slerp(Rotation a, Rotation b, double t, boolean allowFlip * Returns the "dot" product of this Quaternion and {@code b}: * * {@code this.x * b.x + this.y * b.y + this.z * b.z + this.w * b.w} + * @param a This * @param b the Quaternion + * @return The dot product */ public static double dotProduct(Rotation a, Rotation b) { return a.getQ0() * b.getQ0() + a.getQ1() * b.getQ1() + a.getQ2() * b.getQ2() + a.getQ3() * b.getQ3(); diff --git a/src/main/java/nova/core/util/registry/Factory.java b/src/main/java/nova/core/util/registry/Factory.java index fd615b168..66c21e51c 100644 --- a/src/main/java/nova/core/util/registry/Factory.java +++ b/src/main/java/nova/core/util/registry/Factory.java @@ -22,9 +22,7 @@ import net.jodah.typetools.TypeResolver; import nova.core.util.Identifiable; -import nova.internal.core.Game; import nova.internal.core.util.InjectionUtil; -import se.jbee.inject.Dependency; import java.util.Optional; import java.util.function.Function; diff --git a/src/main/java/nova/core/world/World.java b/src/main/java/nova/core/world/World.java index d89565221..8b551f576 100644 --- a/src/main/java/nova/core/world/World.java +++ b/src/main/java/nova/core/world/World.java @@ -77,29 +77,45 @@ public boolean removeBlock(Vector3D position) { /** * Creates an entity * @param factory The entity factory + * @return The added entity */ public abstract Entity addEntity(EntityFactory factory); /** * Creates an entity that holds an item + * @param position The position to add the item to * @param item The item + * @return The added entity */ public abstract Entity addEntity(Vector3D position, Item item); /** * Creates an entity only on the client side. * For example, particle effects. + * + * TODO: Replace this with an actual particle system. + * + * @param factory The entity factory + * @return The added entity */ public abstract Entity addClientEntity(EntityFactory factory); /** * Creates an entity only on the client side. * For example, particle effects. + * + * TODO: Replace this with an actual particle system. + * + * @param The entity type + * @param entity The entity to add + * @return The added entity */ public abstract T addClientEntity(T entity); /** * Destroys an entity, removing it from the world. + * + * @param entity The entity to remove */ public abstract void removeEntity(Entity entity); diff --git a/src/main/java/nova/internal/core/Game.java b/src/main/java/nova/internal/core/Game.java index 68485291f..e2abc6b5d 100644 --- a/src/main/java/nova/internal/core/Game.java +++ b/src/main/java/nova/internal/core/Game.java @@ -75,15 +75,11 @@ public class Game { /** * The synchronized ticker that uses the same thread as the game. - * - * This is @deprecated, use syncTicker() instead. */ private final UpdateTicker.SynchronizedTicker syncTicker; /** * The thread ticker that runs on NOVA's thread. - * - * This is @deprecated, use threadTicker() instead. */ private final UpdateTicker.ThreadTicker threadTicker; @@ -224,6 +220,11 @@ public static FluidManager fluids() { /** * The synchronized ticker that uses the same thread as the game. + * + * @return The synchronous game ticker, which is synchronized + * with the game’s tick speed. + * + * For Minecraft, this is 20hz. */ public static UpdateTicker.SynchronizedTicker syncTicker() { return instance.syncTicker; @@ -231,6 +232,9 @@ public static UpdateTicker.SynchronizedTicker syncTicker() { /** * The thread ticker that runs on NOVA's thread. + * + * @return The asynchronous NOVA ticker, + * which runs as fast as possible. */ public static UpdateTicker.ThreadTicker threadTicker() { return instance.threadTicker; diff --git a/src/main/java/nova/internal/core/di/DICoreModule.java b/src/main/java/nova/internal/core/di/DICoreModule.java index 0ecefbfc9..fb8a77d82 100644 --- a/src/main/java/nova/internal/core/di/DICoreModule.java +++ b/src/main/java/nova/internal/core/di/DICoreModule.java @@ -25,13 +25,9 @@ import java.util.function.Supplier; public class DICoreModule extends BinderModule { - - @Override protected void declare() { - //install(BuildinBundle.PROVIDER); //To allow injection of providers - starbind(Supplier.class).to(new SupplierSupplier()); + starbind(Supplier.class).to(new SupplierModule.SupplierSupplier()); } - } diff --git a/src/main/java/nova/internal/core/di/SupplierModule.java b/src/main/java/nova/internal/core/di/SupplierModule.java index 8887984b0..0ebcd1b89 100644 --- a/src/main/java/nova/internal/core/di/SupplierModule.java +++ b/src/main/java/nova/internal/core/di/SupplierModule.java @@ -16,7 +16,9 @@ * * You should have received a copy of the GNU General Public License * along with NOVA. If not, see . - */package nova.internal.core.di; + */ + +package nova.internal.core.di; import se.jbee.inject.Dependency; import se.jbee.inject.Injector; @@ -25,20 +27,28 @@ import static se.jbee.inject.util.ToString.describe; -final class SupplierSupplier implements Supplier> { +/** + * A dummy class containing the {@link SupplierSupplier} to match + * the rest of the NOVA Dependency Injection setup. + * + * @author ExE Boss + */ +public final class SupplierModule { - @Override - public java.util.function.Supplier supply( Dependency> dependency, Injector injector ) { - Dependency providedType = dependency.onTypeParameter(); - if ( !dependency.getName().isDefault() ) { - providedType = providedType.named( dependency.getName() ); + public static final class SupplierSupplier implements Supplier> { + @Override + public java.util.function.Supplier supply(Dependency> dependency, Injector injector) { + Dependency providedType = dependency.onTypeParameter(); + if (!dependency.getName().isDefault()) { + providedType = providedType.named(dependency.getName()); + } + final Dependency finalProvidedType = providedType; + return () -> SuppliedBy.lazyProvider(finalProvidedType.uninject().ignoredExpiry(), injector).provide(); } - final Dependency finalProvidedType = providedType; - return () -> SuppliedBy.lazyProvider(finalProvidedType.uninject().ignoredExpiry(), injector).provide(); - } - @Override - public String toString() { - return describe( "supplies", java.util.function.Supplier.class ); + @Override + public String toString() { + return describe("supplies", java.util.function.Supplier.class); + } } } diff --git a/src/main/java/nova/internal/core/launch/InitializationException.java b/src/main/java/nova/internal/core/launch/InitializationException.java index 5c5676315..abc80a853 100644 --- a/src/main/java/nova/internal/core/launch/InitializationException.java +++ b/src/main/java/nova/internal/core/launch/InitializationException.java @@ -21,6 +21,8 @@ import nova.core.util.exception.NovaException; public class InitializationException extends NovaException { + private static final long serialVersionUID = 1L; + public InitializationException() { super(); } diff --git a/src/main/java/nova/internal/core/util/InjectionUtil.java b/src/main/java/nova/internal/core/util/InjectionUtil.java index 2340f891a..3deaea4ad 100644 --- a/src/main/java/nova/internal/core/util/InjectionUtil.java +++ b/src/main/java/nova/internal/core/util/InjectionUtil.java @@ -185,9 +185,9 @@ public static T newInstance(Class classToConstruct, boolean printStackTra * @param The object type * @param classToConstruct The class to construct * @return A new instance of the class - * @throws InstantiationException - * @throws IllegalAccessException - * @throws InvocationTargetException + * @throws InstantiationException If an {@link InstantiationException} occurs + * @throws IllegalAccessException If an {@link IllegalAccessException} occurs + * @throws InvocationTargetException If an {@link InvocationTargetException} occurs * @see Constructor#newInstance(java.lang.Object...) */ @SuppressWarnings("unchecked") @@ -204,9 +204,9 @@ public static T newInstanceOrThrow(Class classToConstruct) throws Instant * @param classToConstruct The class to construct * @param mapping Custom DI mapping * @return A new instance of the class - * @throws InstantiationException - * @throws IllegalAccessException - * @throws InvocationTargetException + * @throws InstantiationException If an {@link InstantiationException} occurs + * @throws IllegalAccessException If an {@link IllegalAccessException} occurs + * @throws InvocationTargetException If an {@link InvocationTargetException} occurs * @see Constructor#newInstance(java.lang.Object...) */ @SuppressWarnings("unchecked") diff --git a/src/main/java/nova/internal/core/util/TopologicalSort.java b/src/main/java/nova/internal/core/util/TopologicalSort.java index e1c65c78a..d6abcffe9 100644 --- a/src/main/java/nova/internal/core/util/TopologicalSort.java +++ b/src/main/java/nova/internal/core/util/TopologicalSort.java @@ -21,7 +21,8 @@ public class TopologicalSort { * Sort the input graph into a topologically sorted list * * Uses the reverse depth first search as outlined in ... - * @param graph + * @param The type + * @param graph The graph to sort * @return The sorted list. */ public static List topologicalSort(DirectedGraph graph) { @@ -64,6 +65,7 @@ public static void explore(T node, DirectedGraph graph, List sortedRes } throw new NovaException("There was a cycle detected in the input graph, sorting is not possible", node) { + private static final long serialVersionUID = 1L; }; }
* See {@link #slerp(Rotation, Rotation, double, boolean)} for details. + * + * @param a the first Rotation + * @param b the second Rotation + * @param t the temporal interpolation parameter + * @return The slerp interpolation of Rotations {@code a} and {@code b}, at time {@code t}. */ public static Rotation slerp(Rotation a, Rotation b, double t) { return slerp(a, b, t, true); @@ -123,11 +131,12 @@ public static Rotation slerp(Rotation a, Rotation b, double t) { * "flipping" the source Rotation if needed. * @param a the first Rotation * @param b the second Rotation - * @param t the t interpolation parameter + * @param t the temporal interpolation parameter * @param allowFlip tells whether or not the interpolation allows axis flip + * @return The slerp interpolation of Rotations {@code a} and {@code b}, at time {@code t}. */ public static Rotation slerp(Rotation a, Rotation b, double t, boolean allowFlip) { - // Warning: this method should not normalize the Rotation + // TODO: this method should not normalize the Rotation double cosAngle = dotProduct(a, b); double c1, c2; @@ -156,7 +165,9 @@ public static Rotation slerp(Rotation a, Rotation b, double t, boolean allowFlip * Returns the "dot" product of this Quaternion and {@code b}: *
* {@code this.x * b.x + this.y * b.y + this.z * b.z + this.w * b.w} + * @param a This * @param b the Quaternion + * @return The dot product */ public static double dotProduct(Rotation a, Rotation b) { return a.getQ0() * b.getQ0() + a.getQ1() * b.getQ1() + a.getQ2() * b.getQ2() + a.getQ3() * b.getQ3(); diff --git a/src/main/java/nova/core/util/registry/Factory.java b/src/main/java/nova/core/util/registry/Factory.java index fd615b168..66c21e51c 100644 --- a/src/main/java/nova/core/util/registry/Factory.java +++ b/src/main/java/nova/core/util/registry/Factory.java @@ -22,9 +22,7 @@ import net.jodah.typetools.TypeResolver; import nova.core.util.Identifiable; -import nova.internal.core.Game; import nova.internal.core.util.InjectionUtil; -import se.jbee.inject.Dependency; import java.util.Optional; import java.util.function.Function; diff --git a/src/main/java/nova/core/world/World.java b/src/main/java/nova/core/world/World.java index d89565221..8b551f576 100644 --- a/src/main/java/nova/core/world/World.java +++ b/src/main/java/nova/core/world/World.java @@ -77,29 +77,45 @@ public boolean removeBlock(Vector3D position) { /** * Creates an entity * @param factory The entity factory + * @return The added entity */ public abstract Entity addEntity(EntityFactory factory); /** * Creates an entity that holds an item + * @param position The position to add the item to * @param item The item + * @return The added entity */ public abstract Entity addEntity(Vector3D position, Item item); /** * Creates an entity only on the client side. * For example, particle effects. + *
+ * TODO: Replace this with an actual particle system. + *
+ * For Minecraft, this is 20hz. */ public static UpdateTicker.SynchronizedTicker syncTicker() { return instance.syncTicker; @@ -231,6 +232,9 @@ public static UpdateTicker.SynchronizedTicker syncTicker() { /** * The thread ticker that runs on NOVA's thread. + * + * @return The asynchronous NOVA ticker, + * which runs as fast as possible. */ public static UpdateTicker.ThreadTicker threadTicker() { return instance.threadTicker; diff --git a/src/main/java/nova/internal/core/di/DICoreModule.java b/src/main/java/nova/internal/core/di/DICoreModule.java index 0ecefbfc9..fb8a77d82 100644 --- a/src/main/java/nova/internal/core/di/DICoreModule.java +++ b/src/main/java/nova/internal/core/di/DICoreModule.java @@ -25,13 +25,9 @@ import java.util.function.Supplier; public class DICoreModule extends BinderModule { - - @Override protected void declare() { - //install(BuildinBundle.PROVIDER); //To allow injection of providers - starbind(Supplier.class).to(new SupplierSupplier()); + starbind(Supplier.class).to(new SupplierModule.SupplierSupplier()); } - } diff --git a/src/main/java/nova/internal/core/di/SupplierModule.java b/src/main/java/nova/internal/core/di/SupplierModule.java index 8887984b0..0ebcd1b89 100644 --- a/src/main/java/nova/internal/core/di/SupplierModule.java +++ b/src/main/java/nova/internal/core/di/SupplierModule.java @@ -16,7 +16,9 @@ * * You should have received a copy of the GNU General Public License * along with NOVA. If not, see . - */package nova.internal.core.di; + */ + +package nova.internal.core.di; import se.jbee.inject.Dependency; import se.jbee.inject.Injector; @@ -25,20 +27,28 @@ import static se.jbee.inject.util.ToString.describe; -final class SupplierSupplier implements Supplier> { +/** + * A dummy class containing the {@link SupplierSupplier} to match + * the rest of the NOVA Dependency Injection setup. + * + * @author ExE Boss + */ +public final class SupplierModule { - @Override - public java.util.function.Supplier supply( Dependency> dependency, Injector injector ) { - Dependency providedType = dependency.onTypeParameter(); - if ( !dependency.getName().isDefault() ) { - providedType = providedType.named( dependency.getName() ); + public static final class SupplierSupplier implements Supplier> { + @Override + public java.util.function.Supplier supply(Dependency> dependency, Injector injector) { + Dependency providedType = dependency.onTypeParameter(); + if (!dependency.getName().isDefault()) { + providedType = providedType.named(dependency.getName()); + } + final Dependency finalProvidedType = providedType; + return () -> SuppliedBy.lazyProvider(finalProvidedType.uninject().ignoredExpiry(), injector).provide(); } - final Dependency finalProvidedType = providedType; - return () -> SuppliedBy.lazyProvider(finalProvidedType.uninject().ignoredExpiry(), injector).provide(); - } - @Override - public String toString() { - return describe( "supplies", java.util.function.Supplier.class ); + @Override + public String toString() { + return describe("supplies", java.util.function.Supplier.class); + } } } diff --git a/src/main/java/nova/internal/core/launch/InitializationException.java b/src/main/java/nova/internal/core/launch/InitializationException.java index 5c5676315..abc80a853 100644 --- a/src/main/java/nova/internal/core/launch/InitializationException.java +++ b/src/main/java/nova/internal/core/launch/InitializationException.java @@ -21,6 +21,8 @@ import nova.core.util.exception.NovaException; public class InitializationException extends NovaException { + private static final long serialVersionUID = 1L; + public InitializationException() { super(); } diff --git a/src/main/java/nova/internal/core/util/InjectionUtil.java b/src/main/java/nova/internal/core/util/InjectionUtil.java index 2340f891a..3deaea4ad 100644 --- a/src/main/java/nova/internal/core/util/InjectionUtil.java +++ b/src/main/java/nova/internal/core/util/InjectionUtil.java @@ -185,9 +185,9 @@ public static T newInstance(Class classToConstruct, boolean printStackTra * @param The object type * @param classToConstruct The class to construct * @return A new instance of the class - * @throws InstantiationException - * @throws IllegalAccessException - * @throws InvocationTargetException + * @throws InstantiationException If an {@link InstantiationException} occurs + * @throws IllegalAccessException If an {@link IllegalAccessException} occurs + * @throws InvocationTargetException If an {@link InvocationTargetException} occurs * @see Constructor#newInstance(java.lang.Object...) */ @SuppressWarnings("unchecked") @@ -204,9 +204,9 @@ public static T newInstanceOrThrow(Class classToConstruct) throws Instant * @param classToConstruct The class to construct * @param mapping Custom DI mapping * @return A new instance of the class - * @throws InstantiationException - * @throws IllegalAccessException - * @throws InvocationTargetException + * @throws InstantiationException If an {@link InstantiationException} occurs + * @throws IllegalAccessException If an {@link IllegalAccessException} occurs + * @throws InvocationTargetException If an {@link InvocationTargetException} occurs * @see Constructor#newInstance(java.lang.Object...) */ @SuppressWarnings("unchecked") diff --git a/src/main/java/nova/internal/core/util/TopologicalSort.java b/src/main/java/nova/internal/core/util/TopologicalSort.java index e1c65c78a..d6abcffe9 100644 --- a/src/main/java/nova/internal/core/util/TopologicalSort.java +++ b/src/main/java/nova/internal/core/util/TopologicalSort.java @@ -21,7 +21,8 @@ public class TopologicalSort { * Sort the input graph into a topologically sorted list * * Uses the reverse depth first search as outlined in ... - * @param graph + * @param The type + * @param graph The graph to sort * @return The sorted list. */ public static List topologicalSort(DirectedGraph graph) { @@ -64,6 +65,7 @@ public static void explore(T node, DirectedGraph graph, List sortedRes } throw new NovaException("There was a cycle detected in the input graph, sorting is not possible", node) { + private static final long serialVersionUID = 1L; }; }