diff --git a/src/main/java/com/l2jserver/game/net/packet/client/CM_CHAR_MOVE.java b/src/main/java/com/l2jserver/game/net/packet/client/CM_CHAR_MOVE.java index cb270a293..b972c6010 100644 --- a/src/main/java/com/l2jserver/game/net/packet/client/CM_CHAR_MOVE.java +++ b/src/main/java/com/l2jserver/game/net/packet/client/CM_CHAR_MOVE.java @@ -39,6 +39,9 @@ public class CM_CHAR_MOVE extends AbstractClientPacket { */ public static final int OPCODE = 0x0f; + /** + * The logger + */ private final Logger log = LoggerFactory.getLogger(this.getClass()); /** diff --git a/src/main/java/com/l2jserver/model/world/actor/stat/BaseStats.java b/src/main/java/com/l2jserver/model/world/actor/stat/BaseStats.java index cbbe12ecd..1786c6bdc 100644 --- a/src/main/java/com/l2jserver/model/world/actor/stat/BaseStats.java +++ b/src/main/java/com/l2jserver/model/world/actor/stat/BaseStats.java @@ -22,6 +22,9 @@ import com.l2jserver.model.world.Actor; * @author Rogiel */ public enum BaseStats { + /** + * Strength multipliers + */ STR(0.29, 0.3, 0.31, 0.32, 0.34, 0.35, 0.36, 0.37, 0.39, 0.4, 0.42, 0.43, 0.45, 0.46, 0.48, 0.5, 0.51, 0.53, 0.55, 0.57, 0.59, 0.61, 0.63, 0.66, 0.68, 0.71, 0.73, 0.76, 0.78, 0.81, 0.84, 0.87, 0.9, 0.94, @@ -32,6 +35,9 @@ public enum BaseStats { 4.6, 4.77, 4.94, 5.12, 5.3, 5.49, 5.69, 5.89, 6.11, 6.33, 6.55, 6.79, 7.03, 7.29, 7.55, 7.82, 8.1, 8.39, 8.7, 9.01, 9.33, 9.67), + /** + * Intelligence multipliers + */ INT(0.54, 0.55, 0.56, 0.57, 0.58, 0.59, 0.61, 0.62, 0.63, 0.64, 0.65, 0.67, 0.68, 0.69, 0.71, 0.72, 0.74, 0.75, 0.77, 0.78, 0.8, 0.81, 0.83, 0.85, 0.86, 0.88, 0.9, 0.92, 0.94, 0.95, 0.97, 0.99, 1.01, 1.03, @@ -42,6 +48,9 @@ public enum BaseStats { 2.52, 2.57, 2.62, 2.67, 2.73, 2.78, 2.84, 2.89, 2.95, 3.01, 3.07, 3.13, 3.19, 3.26, 3.32, 3.39, 3.46, 3.53, 3.6, 3.67, 3.74, 3.82), + /** + * Dexterity multipliers + */ DEX(0.84, 0.85, 0.86, 0.86, 0.87, 0.88, 0.89, 0.9, 0.9, 0.91, 0.92, 0.93, 0.94, 0.94, 0.95, 0.96, 0.97, 0.98, 0.99, 1, 1.01, 1.01, 1.02, 1.03, 1.04, 1.05, 1.06, 1.07, 1.08, 1.09, 1.1, 1.11, 1.12, 1.13, @@ -52,6 +61,9 @@ public enum BaseStats { 1.69, 1.71, 1.72, 1.74, 1.75, 1.77, 1.78, 1.8, 1.82, 1.83, 1.85, 1.87, 1.88, 1.9, 1.92, 1.93, 1.95, 1.97, 1.99, 2, 2.02, 2.04), + /** + * Witness multipliers + */ WIT(0.39, 0.4, 0.42, 0.44, 0.46, 0.48, 0.51, 0.53, 0.56, 0.58, 0.61, 0.64, 0.68, 0.71, 0.75, 0.78, 0.82, 0.86, 0.91, 0.95, 1, 1.05, 1.1, 1.16, 1.22, 1.28, 1.34, 1.41, 1.48, 1.55, 1.63, 1.71, 1.8, 1.89, 1.98, @@ -63,6 +75,9 @@ public enum BaseStats { 25.03, 26.28, 27.6, 28.98, 30.43, 31.95, 33.55, 35.22, 36.98, 38.83, 40.77, 42.81, 44.95, 47.2), + /** + * Concentration multipliers + */ CON(0.45, 0.46, 0.47, 0.48, 0.5, 0.51, 0.53, 0.54, 0.56, 0.58, 0.59, 0.61, 0.63, 0.65, 0.67, 0.69, 0.71, 0.73, 0.75, 0.77, 0.8, 0.82, 0.85, 0.87, 0.9, 0.93, 0.95, 0.98, 1.01, 1.04, 1.07, 1.1, 1.14, 1.17, @@ -73,6 +88,9 @@ public enum BaseStats { 4.56, 4.7, 4.84, 4.99, 5.14, 5.29, 5.45, 5.61, 5.78, 5.96, 6.13, 6.32, 6.51, 6.7, 6.9, 7.11, 7.33, 7.54, 7.77, 8, 8.24), + /** + * Mentality multipliers + */ MEN(1, 1.01, 1.02, 1.03, 1.04, 1.05, 1.06, 1.07, 1.08, 1.09, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17, 1.19, 1.2, 1.21, 1.22, 1.23, 1.25, 1.26, 1.27, 1.28, 1.3, 1.31, 1.32, 1.34, 1.35, 1.36, 1.38, 1.39, @@ -89,18 +107,41 @@ public enum BaseStats { */ public final double[] bonus; + /** + * @param bonus + * the bonus multipliers + */ BaseStats(double... bonus) { this.bonus = bonus; } + /** + * Calculates the bonus + * + * @param n + * the level + * @return the bonus for the given level + */ public double calculateBonus(int n) { return bonus[n]; } + /** + * Calculates the bonus + * + * @param actor + * the actor + * @return the bonus for the given actor + */ public double calculateBonus(Actor actor) { return calculateBonus(actor.getStats()); } + /** + * @param stats + * the actor stats + * @return the calculated bonus + */ public double calculateBonus(ActorStats stats) { switch (this) { case CON: diff --git a/src/main/java/com/l2jserver/model/world/character/CharacterInventory.java b/src/main/java/com/l2jserver/model/world/character/CharacterInventory.java index 471e9b0bf..240c51a4c 100644 --- a/src/main/java/com/l2jserver/model/world/character/CharacterInventory.java +++ b/src/main/java/com/l2jserver/model/world/character/CharacterInventory.java @@ -65,6 +65,13 @@ public class CharacterInventory implements Iterable { return null; } + /** + * Checks if the given paperdoll has is occupied + * + * @param paperdoll + * the paperdoll slot + * @return true if has an item + */ public boolean has(InventoryPaperdoll paperdoll) { return getItem(paperdoll) != null; } @@ -131,6 +138,10 @@ public class CharacterInventory implements Iterable { */ public final int id; + /** + * @param id + * the slot id + */ InventoryPaperdoll(int id) { this.id = id; } diff --git a/src/main/java/com/l2jserver/model/world/character/CharacterShortcutContainer.java b/src/main/java/com/l2jserver/model/world/character/CharacterShortcutContainer.java index 3b010f34f..7aea32082 100644 --- a/src/main/java/com/l2jserver/model/world/character/CharacterShortcutContainer.java +++ b/src/main/java/com/l2jserver/model/world/character/CharacterShortcutContainer.java @@ -137,8 +137,15 @@ public class CharacterShortcutContainer implements Iterable { return character; } + /** + * Compares two shortcut slots + * @author Rogiel + */ public static class ShortcutSlotComparator implements Comparator, Serializable { + /** + * The Java Serialization API serial + */ private static final long serialVersionUID = 1L; @Override diff --git a/src/main/java/com/l2jserver/model/world/character/CharacterStats.java b/src/main/java/com/l2jserver/model/world/character/CharacterStats.java index 34b57bb2c..6b74f77d3 100644 --- a/src/main/java/com/l2jserver/model/world/character/CharacterStats.java +++ b/src/main/java/com/l2jserver/model/world/character/CharacterStats.java @@ -260,6 +260,9 @@ public class CharacterStats extends ActorStats { */ private final L2Character character; + /** + * The character calculator + */ @SuppressWarnings("unchecked") private static final CharacterCalculator calculator = new CharacterCalculator(); @@ -294,6 +297,9 @@ public class CharacterStats extends ActorStats { return (int) calc(StatType.MAX_LOAD); } + /** + * Setups the default formulas + */ @SuppressWarnings("unchecked") private void setup() { calculator.addNoSort(BASE_HP_FORMULA, BASE_MP_FORMULA, BASE_CP_FORMULA); @@ -327,12 +333,21 @@ public class CharacterStats extends ActorStats { calculator.sort(); } + /** + * Updates the calculator + */ public void updateCalculator() { calculator.clear(); setup(); addItem(InventoryPaperdoll.RIGHT_HAND); } + /** + * Adds the item formulas to this character calculator + * + * @param paperdoll + * the paperdoll slot + */ private void addItem(InventoryPaperdoll paperdoll) { if (!character.getInventory().has(paperdoll)) return; diff --git a/src/main/java/com/l2jserver/model/world/character/calculator/CharacterCalculator.java b/src/main/java/com/l2jserver/model/world/character/calculator/CharacterCalculator.java index 67355c152..4f1fa7400 100644 --- a/src/main/java/com/l2jserver/model/world/character/calculator/CharacterCalculator.java +++ b/src/main/java/com/l2jserver/model/world/character/calculator/CharacterCalculator.java @@ -27,6 +27,9 @@ import com.l2jserver.util.calculator.Calculator; * @author Rogiel */ public class CharacterCalculator extends ActorCalculator { + /** + * @param calculators the calculators + */ public CharacterCalculator( Calculator... calculators) { super(calculators); diff --git a/src/main/java/com/l2jserver/model/world/character/calculator/CharacterCalculatorContext.java b/src/main/java/com/l2jserver/model/world/character/calculator/CharacterCalculatorContext.java index 558e67dcb..c81e8c7c0 100644 --- a/src/main/java/com/l2jserver/model/world/character/calculator/CharacterCalculatorContext.java +++ b/src/main/java/com/l2jserver/model/world/character/calculator/CharacterCalculatorContext.java @@ -30,6 +30,10 @@ public class CharacterCalculatorContext extends ActorCalculatorContext { */ public final L2Character character; + /** + * Creates a new context + * @param character the character + */ public CharacterCalculatorContext(L2Character character) { super(character); this.character = character; diff --git a/src/main/java/com/l2jserver/model/world/character/calculator/CharacterCalculatorFunction.java b/src/main/java/com/l2jserver/model/world/character/calculator/CharacterCalculatorFunction.java index 1b9c37db4..2029161f2 100644 --- a/src/main/java/com/l2jserver/model/world/character/calculator/CharacterCalculatorFunction.java +++ b/src/main/java/com/l2jserver/model/world/character/calculator/CharacterCalculatorFunction.java @@ -30,6 +30,12 @@ import com.l2jserver.model.world.actor.stat.StatType; */ public abstract class CharacterCalculatorFunction extends ActorCalculatorFunction { + /** + * @param order + * the calculation order + * @param type + * the stat type + */ public CharacterCalculatorFunction(int order, StatType type) { super(order, type); } @@ -41,6 +47,17 @@ public abstract class CharacterCalculatorFunction extends value); } + /** + * Computes the calculated value + * + * @param c + * the character + * @param t + * the template + * @param value + * the input value + * @return the computed value + */ protected abstract double calculate(L2Character c, CharacterTemplate t, double value); } diff --git a/src/main/java/com/l2jserver/model/world/character/calculator/CharacterFormula.java b/src/main/java/com/l2jserver/model/world/character/calculator/CharacterFormula.java index 4b0d7a786..bb3de0d2e 100644 --- a/src/main/java/com/l2jserver/model/world/character/calculator/CharacterFormula.java +++ b/src/main/java/com/l2jserver/model/world/character/calculator/CharacterFormula.java @@ -24,6 +24,10 @@ import com.l2jserver.model.world.actor.stat.StatType; * @author Rogiel */ public abstract class CharacterFormula extends CharacterCalculatorFunction { + /** + * @param order the calculation order + * @param type the stat type + */ public CharacterFormula(int order, StatType type) { super(order, type); } diff --git a/src/main/java/com/l2jserver/model/world/character/calculator/MaximumCPAddCalculator.java b/src/main/java/com/l2jserver/model/world/character/calculator/MaximumCPAddCalculator.java index c6aff5b9f..e8f136a42 100644 --- a/src/main/java/com/l2jserver/model/world/character/calculator/MaximumCPAddCalculator.java +++ b/src/main/java/com/l2jserver/model/world/character/calculator/MaximumCPAddCalculator.java @@ -34,6 +34,9 @@ import com.l2jserver.model.world.actor.stat.StatType; * @author Rogiel */ public class MaximumCPAddCalculator extends CharacterFormula { + /** + * Creates a new instance of this formula + */ public MaximumCPAddCalculator() { super(0x100, StatType.MAX_CP); } diff --git a/src/main/java/com/l2jserver/model/world/character/calculator/MaximumCPBonusCalculator.java b/src/main/java/com/l2jserver/model/world/character/calculator/MaximumCPBonusCalculator.java index af4b04876..cc44010f4 100644 --- a/src/main/java/com/l2jserver/model/world/character/calculator/MaximumCPBonusCalculator.java +++ b/src/main/java/com/l2jserver/model/world/character/calculator/MaximumCPBonusCalculator.java @@ -35,6 +35,9 @@ import com.l2jserver.model.world.actor.stat.StatType; * @author Rogiel */ public class MaximumCPBonusCalculator extends CharacterFormula { + /** + * Creates a new instance of this formula + */ public MaximumCPBonusCalculator() { super(0x100, StatType.MAX_CP); } diff --git a/src/main/java/com/l2jserver/model/world/character/calculator/MaximumHPAddCalculator.java b/src/main/java/com/l2jserver/model/world/character/calculator/MaximumHPAddCalculator.java index c3d5ebb46..5d7ef7e3f 100644 --- a/src/main/java/com/l2jserver/model/world/character/calculator/MaximumHPAddCalculator.java +++ b/src/main/java/com/l2jserver/model/world/character/calculator/MaximumHPAddCalculator.java @@ -34,6 +34,9 @@ import com.l2jserver.model.world.actor.stat.StatType; * @author Rogiel */ public class MaximumHPAddCalculator extends CharacterFormula { + /** + * Creates a new instance of this formula + */ public MaximumHPAddCalculator() { super(0x100, StatType.MAX_HP); } diff --git a/src/main/java/com/l2jserver/model/world/character/calculator/MaximumMPAddCalculator.java b/src/main/java/com/l2jserver/model/world/character/calculator/MaximumMPAddCalculator.java index 32c2a66c2..f4b95009c 100644 --- a/src/main/java/com/l2jserver/model/world/character/calculator/MaximumMPAddCalculator.java +++ b/src/main/java/com/l2jserver/model/world/character/calculator/MaximumMPAddCalculator.java @@ -34,6 +34,9 @@ import com.l2jserver.model.world.actor.stat.StatType; * @author Rogiel */ public class MaximumMPAddCalculator extends CharacterFormula { + /** + * Creates a new instance of this formula + */ public MaximumMPAddCalculator() { super(0x100, StatType.MAX_MP); } diff --git a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseAttackAccuracyCalculator.java b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseAttackAccuracyCalculator.java index 55e3dfe58..c2bec4e05 100644 --- a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseAttackAccuracyCalculator.java +++ b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseAttackAccuracyCalculator.java @@ -31,6 +31,9 @@ import com.l2jserver.model.world.character.calculator.CharacterFormula; * @author Rogiel */ public class CharacterBaseAttackAccuracyCalculator extends CharacterFormula { + /** + * Creates a new instance of this formula + */ public CharacterBaseAttackAccuracyCalculator() { super(0x000, StatType.ACCURACY_COMBAT); } diff --git a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseAttackEvasionCalculator.java b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseAttackEvasionCalculator.java index 4a1012987..c895c27c5 100644 --- a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseAttackEvasionCalculator.java +++ b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseAttackEvasionCalculator.java @@ -31,6 +31,9 @@ import com.l2jserver.model.world.character.calculator.CharacterFormula; * @author Rogiel */ public class CharacterBaseAttackEvasionCalculator extends CharacterFormula { + /** + * Creates a new instance of this formula + */ public CharacterBaseAttackEvasionCalculator() { super(0x000, StatType.EVASION_RATE); } diff --git a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseCPCalculator.java b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseCPCalculator.java index fccb9235c..c944788c3 100644 --- a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseCPCalculator.java +++ b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseCPCalculator.java @@ -31,6 +31,9 @@ import com.l2jserver.model.world.character.calculator.CharacterFormula; * @author Rogiel */ public class CharacterBaseCPCalculator extends CharacterFormula { + /** + * Creates a new instance of this formula + */ public CharacterBaseCPCalculator() { super(0x000, StatType.MAX_CP); } diff --git a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseConcentrationCalculator.java b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseConcentrationCalculator.java index ab163e8e7..0d29cda23 100644 --- a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseConcentrationCalculator.java +++ b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseConcentrationCalculator.java @@ -31,6 +31,9 @@ import com.l2jserver.model.world.character.calculator.CharacterFormula; * @author Rogiel */ public class CharacterBaseConcentrationCalculator extends CharacterFormula { + /** + * Creates a new instance of this formula + */ public CharacterBaseConcentrationCalculator() { super(0x000, StatType.STAT_CON); } diff --git a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseDexterityCalculator.java b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseDexterityCalculator.java index c87e35c03..43c69b5f8 100644 --- a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseDexterityCalculator.java +++ b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseDexterityCalculator.java @@ -31,6 +31,9 @@ import com.l2jserver.model.world.character.calculator.CharacterFormula; * @author Rogiel */ public class CharacterBaseDexterityCalculator extends CharacterFormula { + /** + * Creates a new instance of this formula + */ public CharacterBaseDexterityCalculator() { super(0x000, StatType.STAT_DEX); } diff --git a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseHPCalculator.java b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseHPCalculator.java index 412f6be62..f024be7eb 100644 --- a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseHPCalculator.java +++ b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseHPCalculator.java @@ -31,6 +31,9 @@ import com.l2jserver.model.world.character.calculator.CharacterFormula; * @author Rogiel */ public class CharacterBaseHPCalculator extends CharacterFormula { + /** + * Creates a new instance of this formula + */ public CharacterBaseHPCalculator() { super(0x000, StatType.MAX_HP); } diff --git a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseIntelligenceCalculator.java b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseIntelligenceCalculator.java index 08680931c..31ceaaa8a 100644 --- a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseIntelligenceCalculator.java +++ b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseIntelligenceCalculator.java @@ -31,6 +31,9 @@ import com.l2jserver.model.world.character.calculator.CharacterFormula; * @author Rogiel */ public class CharacterBaseIntelligenceCalculator extends CharacterFormula { + /** + * Creates a new instance of this formula + */ public CharacterBaseIntelligenceCalculator() { super(0x000, StatType.STAT_INT); } diff --git a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseMPCalculator.java b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseMPCalculator.java index 8884ab404..9fdb7e745 100644 --- a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseMPCalculator.java +++ b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseMPCalculator.java @@ -31,6 +31,9 @@ import com.l2jserver.model.world.character.calculator.CharacterFormula; * @author Rogiel */ public class CharacterBaseMPCalculator extends CharacterFormula { + /** + * Creates a new instance of this formula + */ public CharacterBaseMPCalculator() { super(0x000, StatType.MAX_MP); } diff --git a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseMagicalAttackCalculator.java b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseMagicalAttackCalculator.java index cc930bab6..436a1891a 100644 --- a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseMagicalAttackCalculator.java +++ b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseMagicalAttackCalculator.java @@ -32,6 +32,9 @@ import com.l2jserver.model.world.character.calculator.CharacterFormula; * @author Rogiel */ public class CharacterBaseMagicalAttackCalculator extends CharacterFormula { + /** + * Creates a new instance of this formula + */ public CharacterBaseMagicalAttackCalculator() { super(0x000, StatType.MAGIC_ATTACK); } diff --git a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseMagicalAttackSpeedCalculator.java b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseMagicalAttackSpeedCalculator.java index 7a2d5eec7..1d4a0584e 100644 --- a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseMagicalAttackSpeedCalculator.java +++ b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseMagicalAttackSpeedCalculator.java @@ -31,6 +31,9 @@ import com.l2jserver.model.world.character.calculator.CharacterFormula; * @author Rogiel */ public class CharacterBaseMagicalAttackSpeedCalculator extends CharacterFormula { + /** + * Creates a new instance of this formula + */ public CharacterBaseMagicalAttackSpeedCalculator() { super(0x000, StatType.MAGIC_ATTACK_SPEED); } diff --git a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseMagicalCriticalRateCalculator.java b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseMagicalCriticalRateCalculator.java index 70a8fcb4c..2cacc98c7 100644 --- a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseMagicalCriticalRateCalculator.java +++ b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseMagicalCriticalRateCalculator.java @@ -33,6 +33,9 @@ import com.l2jserver.model.world.character.calculator.CharacterFormula; */ public class CharacterBaseMagicalCriticalRateCalculator extends CharacterFormula { + /** + * Creates a new instance of this formula + */ public CharacterBaseMagicalCriticalRateCalculator() { super(0x000, StatType.MCRITICAL_RATE); } diff --git a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseMagicalDefenseCalculator.java b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseMagicalDefenseCalculator.java index 82405930f..77881b398 100644 --- a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseMagicalDefenseCalculator.java +++ b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseMagicalDefenseCalculator.java @@ -42,6 +42,9 @@ import com.l2jserver.model.world.character.calculator.CharacterFormula; * @author Rogiel */ public class CharacterBaseMagicalDefenseCalculator extends CharacterFormula { + /** + * Creates a new instance of this formula + */ public CharacterBaseMagicalDefenseCalculator() { super(0x000, StatType.MAGIC_DEFENSE); } diff --git a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseMentalityCalculator.java b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseMentalityCalculator.java index 4f5970dc5..1d0bb4fa3 100644 --- a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseMentalityCalculator.java +++ b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseMentalityCalculator.java @@ -31,6 +31,9 @@ import com.l2jserver.model.world.character.calculator.CharacterFormula; * @author Rogiel */ public class CharacterBaseMentalityCalculator extends CharacterFormula { + /** + * Creates a new instance of this formula + */ public CharacterBaseMentalityCalculator() { super(0x000, StatType.STAT_MEN); } diff --git a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBasePhysicalAttackCalculator.java b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBasePhysicalAttackCalculator.java index 03915e319..71d7e37eb 100644 --- a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBasePhysicalAttackCalculator.java +++ b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBasePhysicalAttackCalculator.java @@ -33,6 +33,9 @@ import com.l2jserver.model.world.character.calculator.CharacterFormula; * @author Rogiel */ public class CharacterBasePhysicalAttackCalculator extends CharacterFormula { + /** + * Creates a new instance of this formula + */ public CharacterBasePhysicalAttackCalculator() { super(0x000, StatType.POWER_ATTACK); } diff --git a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBasePhysicalAttackSpeedCalculator.java b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBasePhysicalAttackSpeedCalculator.java index e0545cb9f..bc89d99d2 100644 --- a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBasePhysicalAttackSpeedCalculator.java +++ b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBasePhysicalAttackSpeedCalculator.java @@ -33,6 +33,9 @@ import com.l2jserver.model.world.character.calculator.CharacterFormula; */ public class CharacterBasePhysicalAttackSpeedCalculator extends CharacterFormula { + /** + * Creates a new instance of this formula + */ public CharacterBasePhysicalAttackSpeedCalculator() { super(0x000, StatType.POWER_ATTACK_SPEED); } diff --git a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBasePhysicalCriticalRateCalculator.java b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBasePhysicalCriticalRateCalculator.java index 255001947..01851585c 100644 --- a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBasePhysicalCriticalRateCalculator.java +++ b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBasePhysicalCriticalRateCalculator.java @@ -34,6 +34,9 @@ import com.l2jserver.model.world.character.calculator.CharacterFormula; */ public class CharacterBasePhysicalCriticalRateCalculator extends CharacterFormula { + /** + * Creates a new instance of this formula + */ public CharacterBasePhysicalCriticalRateCalculator() { super(0x000, StatType.CRITICAL_RATE); } diff --git a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBasePhysicalDefenseCalculator.java b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBasePhysicalDefenseCalculator.java index c5039acf4..fa5e60869 100644 --- a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBasePhysicalDefenseCalculator.java +++ b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBasePhysicalDefenseCalculator.java @@ -44,6 +44,9 @@ import com.l2jserver.model.world.character.calculator.CharacterFormula; * @author Rogiel */ public class CharacterBasePhysicalDefenseCalculator extends CharacterFormula { + /** + * Creates a new instance of this formula + */ public CharacterBasePhysicalDefenseCalculator() { super(0x000, StatType.POWER_DEFENSE); } diff --git a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseRunSpeedCalculator.java b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseRunSpeedCalculator.java index 19c667e52..0f6bcf553 100644 --- a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseRunSpeedCalculator.java +++ b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseRunSpeedCalculator.java @@ -32,6 +32,9 @@ import com.l2jserver.model.world.character.calculator.CharacterFormula; * @author Rogiel */ public class CharacterBaseRunSpeedCalculator extends CharacterFormula { + /** + * Creates a new instance of this formula + */ public CharacterBaseRunSpeedCalculator() { super(0x000, StatType.RUN_SPEED); } diff --git a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseStrengthCalculator.java b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseStrengthCalculator.java index 0a81d5dda..1b8cba461 100644 --- a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseStrengthCalculator.java +++ b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseStrengthCalculator.java @@ -31,6 +31,9 @@ import com.l2jserver.model.world.character.calculator.CharacterFormula; * @author Rogiel */ public class CharacterBaseStrengthCalculator extends CharacterFormula { + /** + * Creates a new instance of this formula + */ public CharacterBaseStrengthCalculator() { super(0x000, StatType.STAT_STR); } diff --git a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseWalkSpeedCalculator.java b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseWalkSpeedCalculator.java index ab963a59c..e4f2c57fb 100644 --- a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseWalkSpeedCalculator.java +++ b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseWalkSpeedCalculator.java @@ -32,6 +32,9 @@ import com.l2jserver.model.world.character.calculator.CharacterFormula; * @author Rogiel */ public class CharacterBaseWalkSpeedCalculator extends CharacterFormula { + /** + * Creates a new instance of this formula + */ public CharacterBaseWalkSpeedCalculator() { super(0x000, StatType.WALK_SPEED); } diff --git a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseWitnessCalculator.java b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseWitnessCalculator.java index 791ddad26..4eeea6c52 100644 --- a/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseWitnessCalculator.java +++ b/src/main/java/com/l2jserver/model/world/character/calculator/base/CharacterBaseWitnessCalculator.java @@ -31,6 +31,9 @@ import com.l2jserver.model.world.character.calculator.CharacterFormula; * @author Rogiel */ public class CharacterBaseWitnessCalculator extends CharacterFormula { + /** + * Creates a new instance of this formula + */ public CharacterBaseWitnessCalculator() { super(0x000, StatType.STAT_WIT); } diff --git a/src/main/java/com/l2jserver/model/world/character/event/CharacterListener.java b/src/main/java/com/l2jserver/model/world/character/event/CharacterListener.java index 46a97041c..168ac0c6e 100644 --- a/src/main/java/com/l2jserver/model/world/character/event/CharacterListener.java +++ b/src/main/java/com/l2jserver/model/world/character/event/CharacterListener.java @@ -25,6 +25,9 @@ import com.l2jserver.service.game.world.event.TypedWorldListener; */ public abstract class CharacterListener extends TypedWorldListener { + /** + * Creates a new instance + */ public CharacterListener() { super(CharacterEvent.class); } diff --git a/src/main/java/com/l2jserver/model/world/clan/ClanListener.java b/src/main/java/com/l2jserver/model/world/clan/ClanListener.java index bb2872e95..65dd8bcd1 100644 --- a/src/main/java/com/l2jserver/model/world/clan/ClanListener.java +++ b/src/main/java/com/l2jserver/model/world/clan/ClanListener.java @@ -24,6 +24,9 @@ import com.l2jserver.service.game.world.event.TypedWorldListener; * @author Rogiel */ public abstract class ClanListener extends TypedWorldListener { + /** + * Creates a new instance + */ public ClanListener() { super(ClanEvent.class); } diff --git a/src/main/java/com/l2jserver/model/world/item/ItemListener.java b/src/main/java/com/l2jserver/model/world/item/ItemListener.java index 902737d37..307325c91 100644 --- a/src/main/java/com/l2jserver/model/world/item/ItemListener.java +++ b/src/main/java/com/l2jserver/model/world/item/ItemListener.java @@ -24,6 +24,9 @@ import com.l2jserver.service.game.world.event.TypedWorldListener; * @author Rogiel */ public abstract class ItemListener extends TypedWorldListener { + /** + * Creates a new instance + */ public ItemListener() { super(ItemEvent.class); } diff --git a/src/main/java/com/l2jserver/model/world/npc/NPCStats.java b/src/main/java/com/l2jserver/model/world/npc/NPCStats.java index 1d62873bf..f6f00bacb 100644 --- a/src/main/java/com/l2jserver/model/world/npc/NPCStats.java +++ b/src/main/java/com/l2jserver/model/world/npc/NPCStats.java @@ -204,6 +204,9 @@ public class NPCStats extends ActorStats { */ private final NPC npc; + /** + * The NPC calculator + */ private static final NPCCalculator calculator = new NPCCalculator(); /** diff --git a/src/main/java/com/l2jserver/model/world/npc/calculator/NPCCalculator.java b/src/main/java/com/l2jserver/model/world/npc/calculator/NPCCalculator.java index 8e44f8d42..e8a3802af 100644 --- a/src/main/java/com/l2jserver/model/world/npc/calculator/NPCCalculator.java +++ b/src/main/java/com/l2jserver/model/world/npc/calculator/NPCCalculator.java @@ -23,6 +23,10 @@ import com.l2jserver.model.world.actor.calculator.ActorCalculator; * */ public class NPCCalculator extends ActorCalculator { + /** + * @param calculators + * the calculators + */ public NPCCalculator(NPCCalculator... calculators) { super(calculators); } diff --git a/src/main/java/com/l2jserver/model/world/npc/calculator/NPCCalculatorContext.java b/src/main/java/com/l2jserver/model/world/npc/calculator/NPCCalculatorContext.java index 28dc14603..91887965c 100644 --- a/src/main/java/com/l2jserver/model/world/npc/calculator/NPCCalculatorContext.java +++ b/src/main/java/com/l2jserver/model/world/npc/calculator/NPCCalculatorContext.java @@ -30,6 +30,10 @@ public class NPCCalculatorContext extends ActorCalculatorContext { */ public final NPC npc; + /** + * Creates a new calculator context + * @param npc the {@link NPC} + */ public NPCCalculatorContext(NPC npc) { super(npc); this.npc = npc; diff --git a/src/main/java/com/l2jserver/model/world/npc/calculator/NPCCalculatorFunction.java b/src/main/java/com/l2jserver/model/world/npc/calculator/NPCCalculatorFunction.java index 9fac8bd50..0139d5460 100644 --- a/src/main/java/com/l2jserver/model/world/npc/calculator/NPCCalculatorFunction.java +++ b/src/main/java/com/l2jserver/model/world/npc/calculator/NPCCalculatorFunction.java @@ -18,6 +18,7 @@ package com.l2jserver.model.world.npc.calculator; import com.l2jserver.model.template.ActorTemplate; import com.l2jserver.model.template.NPCTemplate; +import com.l2jserver.model.template.Template; import com.l2jserver.model.world.Actor; import com.l2jserver.model.world.NPC; import com.l2jserver.model.world.actor.calculator.ActorCalculatorFunction; @@ -29,6 +30,14 @@ import com.l2jserver.model.world.actor.stat.StatType; * @author Rogiel */ public abstract class NPCCalculatorFunction extends ActorCalculatorFunction { + /** + * Creates a new function + * + * @param order + * the calculation order + * @param type + * the stat type + */ public NPCCalculatorFunction(int order, StatType type) { super(order, type); } @@ -39,5 +48,16 @@ public abstract class NPCCalculatorFunction extends ActorCalculatorFunction { return calculate((NPC) a, (NPCTemplate) actorTemplate, value); } - protected abstract double calculate(NPC c, NPCTemplate t, double value); + /** + * Calculates the value + * + * @param n + * the {@link NPC} + * @param t + * the {@link Template} + * @param value + * the original value + * @return the output value (calculated) + */ + protected abstract double calculate(NPC n, NPCTemplate t, double value); } diff --git a/src/main/java/com/l2jserver/model/world/npc/calculator/NPCFormula.java b/src/main/java/com/l2jserver/model/world/npc/calculator/NPCFormula.java index cf83ad10d..01cb13dd3 100644 --- a/src/main/java/com/l2jserver/model/world/npc/calculator/NPCFormula.java +++ b/src/main/java/com/l2jserver/model/world/npc/calculator/NPCFormula.java @@ -23,6 +23,14 @@ import com.l2jserver.model.world.actor.stat.StatType; * */ public abstract class NPCFormula extends NPCCalculatorFunction { + /** + * Creates a new formula + * + * @param order + * the calculation order + * @param type + * the stat type + */ public NPCFormula(int order, StatType type) { super(order, type); } diff --git a/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseAttackEvasionCalculator.java b/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseAttackEvasionCalculator.java index efd1f87dd..505552c23 100644 --- a/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseAttackEvasionCalculator.java +++ b/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseAttackEvasionCalculator.java @@ -31,6 +31,9 @@ import com.l2jserver.model.world.npc.calculator.NPCFormula; * @author Rogiel */ public class NPCBaseAttackEvasionCalculator extends NPCFormula { + /** + * Creates a new instance of this formula + */ public NPCBaseAttackEvasionCalculator() { super(0x000, StatType.EVASION_RATE); } diff --git a/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseConcentrationCalculator.java b/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseConcentrationCalculator.java index a0bea2f0f..df289d9e2 100644 --- a/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseConcentrationCalculator.java +++ b/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseConcentrationCalculator.java @@ -31,6 +31,9 @@ import com.l2jserver.model.world.npc.calculator.NPCFormula; * @author Rogiel */ public class NPCBaseConcentrationCalculator extends NPCFormula { + /** + * Creates a new instance of this formula + */ public NPCBaseConcentrationCalculator() { super(0x000, StatType.STAT_CON); } diff --git a/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseDexterityCalculator.java b/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseDexterityCalculator.java index c70cd3090..3de341abf 100644 --- a/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseDexterityCalculator.java +++ b/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseDexterityCalculator.java @@ -31,6 +31,9 @@ import com.l2jserver.model.world.npc.calculator.NPCFormula; * @author Rogiel */ public class NPCBaseDexterityCalculator extends NPCFormula { + /** + * Creates a new instance of this formula + */ public NPCBaseDexterityCalculator() { super(0x000, StatType.STAT_DEX); } diff --git a/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseHPCalculator.java b/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseHPCalculator.java index c2f3ccad9..a6d2c9c5d 100644 --- a/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseHPCalculator.java +++ b/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseHPCalculator.java @@ -31,6 +31,9 @@ import com.l2jserver.model.world.npc.calculator.NPCFormula; * @author Rogiel */ public class NPCBaseHPCalculator extends NPCFormula { + /** + * Creates a new instance of this formula + */ public NPCBaseHPCalculator() { super(0x000, StatType.MAX_HP); } diff --git a/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseIntelligenceCalculator.java b/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseIntelligenceCalculator.java index b9330f5f1..c6584fac0 100644 --- a/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseIntelligenceCalculator.java +++ b/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseIntelligenceCalculator.java @@ -31,6 +31,9 @@ import com.l2jserver.model.world.npc.calculator.NPCFormula; * @author Rogiel */ public class NPCBaseIntelligenceCalculator extends NPCFormula { + /** + * Creates a new instance of this formula + */ public NPCBaseIntelligenceCalculator() { super(0x000, StatType.STAT_INT); } diff --git a/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseMPCalculator.java b/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseMPCalculator.java index ea6984212..34f4f8d14 100644 --- a/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseMPCalculator.java +++ b/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseMPCalculator.java @@ -31,6 +31,9 @@ import com.l2jserver.model.world.npc.calculator.NPCFormula; * @author Rogiel */ public class NPCBaseMPCalculator extends NPCFormula { + /** + * Creates a new instance of this formula + */ public NPCBaseMPCalculator() { super(0x000, StatType.MAX_MP); } diff --git a/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseMagicalAttackCalculator.java b/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseMagicalAttackCalculator.java index b95b22dee..e77ddf8f6 100644 --- a/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseMagicalAttackCalculator.java +++ b/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseMagicalAttackCalculator.java @@ -32,6 +32,9 @@ import com.l2jserver.model.world.npc.calculator.NPCFormula; * @author Rogiel */ public class NPCBaseMagicalAttackCalculator extends NPCFormula { + /** + * Creates a new instance of this formula + */ public NPCBaseMagicalAttackCalculator() { super(0x000, StatType.MAGIC_ATTACK); } diff --git a/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseMagicalAttackSpeedCalculator.java b/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseMagicalAttackSpeedCalculator.java index f049ab6d6..194d7d84f 100644 --- a/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseMagicalAttackSpeedCalculator.java +++ b/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseMagicalAttackSpeedCalculator.java @@ -31,6 +31,9 @@ import com.l2jserver.model.world.npc.calculator.NPCFormula; * @author Rogiel */ public class NPCBaseMagicalAttackSpeedCalculator extends NPCFormula { + /** + * Creates a new instance of this formula + */ public NPCBaseMagicalAttackSpeedCalculator() { super(0x000, StatType.MAGIC_ATTACK_SPEED); } diff --git a/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseMagicalCriticalRateCalculator.java b/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseMagicalCriticalRateCalculator.java index b9037c86f..ced2b863e 100644 --- a/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseMagicalCriticalRateCalculator.java +++ b/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseMagicalCriticalRateCalculator.java @@ -32,6 +32,9 @@ import com.l2jserver.model.world.npc.calculator.NPCFormula; * @author Rogiel */ public class NPCBaseMagicalCriticalRateCalculator extends NPCFormula { + /** + * Creates a new instance of this formula + */ public NPCBaseMagicalCriticalRateCalculator() { super(0x000, StatType.MCRITICAL_RATE); } diff --git a/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseMagicalDefenseCalculator.java b/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseMagicalDefenseCalculator.java index 94989204f..2c76a85df 100644 --- a/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseMagicalDefenseCalculator.java +++ b/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseMagicalDefenseCalculator.java @@ -42,6 +42,9 @@ import com.l2jserver.model.world.npc.calculator.NPCFormula; * @author Rogiel */ public class NPCBaseMagicalDefenseCalculator extends NPCFormula { + /** + * Creates a new instance of this formula + */ public NPCBaseMagicalDefenseCalculator() { super(0x000, StatType.MAGIC_DEFENSE); } diff --git a/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseMentalityCalculator.java b/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseMentalityCalculator.java index 631c83513..4c1c7f434 100644 --- a/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseMentalityCalculator.java +++ b/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseMentalityCalculator.java @@ -31,6 +31,9 @@ import com.l2jserver.model.world.npc.calculator.NPCFormula; * @author Rogiel */ public class NPCBaseMentalityCalculator extends NPCFormula { + /** + * Creates a new instance of this formula + */ public NPCBaseMentalityCalculator() { super(0x000, StatType.STAT_MEN); } diff --git a/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBasePhysicalAttackCalculator.java b/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBasePhysicalAttackCalculator.java index 8fd161b54..3757c9545 100644 --- a/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBasePhysicalAttackCalculator.java +++ b/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBasePhysicalAttackCalculator.java @@ -33,6 +33,9 @@ import com.l2jserver.model.world.npc.calculator.NPCFormula; * @author Rogiel */ public class NPCBasePhysicalAttackCalculator extends NPCFormula { + /** + * Creates a new instance of this formula + */ public NPCBasePhysicalAttackCalculator() { super(0x000, StatType.POWER_ATTACK); } diff --git a/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBasePhysicalAttackSpeedCalculator.java b/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBasePhysicalAttackSpeedCalculator.java index 98f921ca8..a06b72683 100644 --- a/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBasePhysicalAttackSpeedCalculator.java +++ b/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBasePhysicalAttackSpeedCalculator.java @@ -32,6 +32,9 @@ import com.l2jserver.model.world.npc.calculator.NPCFormula; * @author Rogiel */ public class NPCBasePhysicalAttackSpeedCalculator extends NPCFormula { + /** + * Creates a new instance of this formula + */ public NPCBasePhysicalAttackSpeedCalculator() { super(0x000, StatType.POWER_ATTACK_SPEED); } diff --git a/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBasePhysicalCriticalRateCalculator.java b/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBasePhysicalCriticalRateCalculator.java index 664c5433e..f94410db4 100644 --- a/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBasePhysicalCriticalRateCalculator.java +++ b/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBasePhysicalCriticalRateCalculator.java @@ -33,6 +33,9 @@ import com.l2jserver.model.world.npc.calculator.NPCFormula; * @author Rogiel */ public class NPCBasePhysicalCriticalRateCalculator extends NPCFormula { + /** + * Creates a new instance of this formula + */ public NPCBasePhysicalCriticalRateCalculator() { super(0x000, StatType.CRITICAL_RATE); } diff --git a/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBasePhysicalDefenseCalculator.java b/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBasePhysicalDefenseCalculator.java index 13a025314..39c01fc7e 100644 --- a/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBasePhysicalDefenseCalculator.java +++ b/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBasePhysicalDefenseCalculator.java @@ -44,6 +44,9 @@ import com.l2jserver.model.world.npc.calculator.NPCFormula; * @author Rogiel */ public class NPCBasePhysicalDefenseCalculator extends NPCFormula { + /** + * Creates a new instance of this formula + */ public NPCBasePhysicalDefenseCalculator() { super(0x000, StatType.POWER_DEFENSE); } diff --git a/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseRunSpeedCalculator.java b/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseRunSpeedCalculator.java index a0e0c7530..08416e43a 100644 --- a/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseRunSpeedCalculator.java +++ b/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseRunSpeedCalculator.java @@ -32,6 +32,9 @@ import com.l2jserver.model.world.npc.calculator.NPCFormula; * @author Rogiel */ public class NPCBaseRunSpeedCalculator extends NPCFormula { + /** + * Creates a new instance of this formula + */ public NPCBaseRunSpeedCalculator() { super(0x000, StatType.RUN_SPEED); } diff --git a/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseStrengthCalculator.java b/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseStrengthCalculator.java index cb521b298..784e448e0 100644 --- a/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseStrengthCalculator.java +++ b/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseStrengthCalculator.java @@ -31,6 +31,9 @@ import com.l2jserver.model.world.npc.calculator.NPCFormula; * @author Rogiel */ public class NPCBaseStrengthCalculator extends NPCFormula { + /** + * Creates a new instance of this formula + */ public NPCBaseStrengthCalculator() { super(0x000, StatType.STAT_STR); } diff --git a/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseWalkSpeedCalculator.java b/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseWalkSpeedCalculator.java index 67808d012..3d07b4c0c 100644 --- a/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseWalkSpeedCalculator.java +++ b/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseWalkSpeedCalculator.java @@ -32,6 +32,9 @@ import com.l2jserver.model.world.npc.calculator.NPCFormula; * @author Rogiel */ public class NPCBaseWalkSpeedCalculator extends NPCFormula { + /** + * Creates a new instance of this formula + */ public NPCBaseWalkSpeedCalculator() { super(0x000, StatType.WALK_SPEED); } diff --git a/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseWitnessCalculator.java b/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseWitnessCalculator.java index e34267c23..9f9e2b775 100644 --- a/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseWitnessCalculator.java +++ b/src/main/java/com/l2jserver/model/world/npc/calculator/base/NPCBaseWitnessCalculator.java @@ -31,6 +31,9 @@ import com.l2jserver.model.world.npc.calculator.NPCFormula; * @author Rogiel */ public class NPCBaseWitnessCalculator extends NPCFormula { + /** + * Creates a new instance of this formula + */ public NPCBaseWitnessCalculator() { super(0x000, StatType.STAT_WIT); } diff --git a/src/main/java/com/l2jserver/model/world/npc/controller/TeleporterController.java b/src/main/java/com/l2jserver/model/world/npc/controller/TeleporterController.java index 727c21b32..1cae60d73 100644 --- a/src/main/java/com/l2jserver/model/world/npc/controller/TeleporterController.java +++ b/src/main/java/com/l2jserver/model/world/npc/controller/TeleporterController.java @@ -36,6 +36,9 @@ public class TeleporterController extends BaseNPCController { */ @Inject protected SpawnService spawnService; + /** + * The teleportation template id provider + */ @Inject protected TeleportationTemplateIDProvider teleportationIdProvider; diff --git a/src/main/java/com/l2jserver/model/world/npc/event/NPCEvent.java b/src/main/java/com/l2jserver/model/world/npc/event/NPCEvent.java index 81921eba0..dca0044a0 100644 --- a/src/main/java/com/l2jserver/model/world/npc/event/NPCEvent.java +++ b/src/main/java/com/l2jserver/model/world/npc/event/NPCEvent.java @@ -25,5 +25,8 @@ import com.l2jserver.service.game.world.event.WorldEvent; * @author Rogiel */ public interface NPCEvent extends WorldEvent { + /** + * @return the NPC + */ NPC getNPC(); } diff --git a/src/main/java/com/l2jserver/model/world/npc/event/NPCListener.java b/src/main/java/com/l2jserver/model/world/npc/event/NPCListener.java index bc6bcaa8c..265b94395 100644 --- a/src/main/java/com/l2jserver/model/world/npc/event/NPCListener.java +++ b/src/main/java/com/l2jserver/model/world/npc/event/NPCListener.java @@ -24,6 +24,9 @@ import com.l2jserver.service.game.world.event.TypedWorldListener; * @author Rogiel */ public abstract class NPCListener extends TypedWorldListener { + /** + * Creates a new instance + */ public NPCListener() { super(NPCEvent.class); } diff --git a/src/main/java/com/l2jserver/model/world/player/event/PlayerListener.java b/src/main/java/com/l2jserver/model/world/player/event/PlayerListener.java index 96a04b45e..53ad596c7 100644 --- a/src/main/java/com/l2jserver/model/world/player/event/PlayerListener.java +++ b/src/main/java/com/l2jserver/model/world/player/event/PlayerListener.java @@ -24,6 +24,9 @@ import com.l2jserver.service.game.world.event.TypedWorldListener; * @author Rogiel */ public abstract class PlayerListener extends TypedWorldListener { + /** + * Creates a new instance + */ public PlayerListener() { super(PlayerEvent.class); } diff --git a/src/main/java/com/l2jserver/model/world/player/event/PlayerTeleportingEvent.java b/src/main/java/com/l2jserver/model/world/player/event/PlayerTeleportingEvent.java index f26952fe2..f5e26260c 100644 --- a/src/main/java/com/l2jserver/model/world/player/event/PlayerTeleportingEvent.java +++ b/src/main/java/com/l2jserver/model/world/player/event/PlayerTeleportingEvent.java @@ -29,7 +29,13 @@ import com.l2jserver.util.geometry.Point3D; * @author Rogiel */ public class PlayerTeleportingEvent implements PlayerEvent { + /** + * The player object + */ private final Player player; + /** + * The teleportation point + */ private final Point3D point; /** diff --git a/src/main/java/com/l2jserver/service/AbstractService.java b/src/main/java/com/l2jserver/service/AbstractService.java index d1ef57f40..84c2b0799 100644 --- a/src/main/java/com/l2jserver/service/AbstractService.java +++ b/src/main/java/com/l2jserver/service/AbstractService.java @@ -45,6 +45,12 @@ public abstract class AbstractService implements Service { } } + /** + * Starts the service. This method is invoked internally by {@link #start()} + * + * @throws ServiceStartException + * if any error occur while starting the service + */ protected void doStart() throws ServiceStartException { } @@ -59,6 +65,12 @@ public abstract class AbstractService implements Service { } } + /** + * Stops the service. This method is invoked internally by {@link #stop()} + * + * @throws ServiceStopException + * if any error occur while stopping the service + */ protected void doStop() throws ServiceStopException { } @@ -86,9 +98,17 @@ public abstract class AbstractService implements Service { return deps.value(); } + /** + * Service dependency metadata + * + * @author Rogiel + */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.TYPE) public @interface Depends { + /** + * @return the service's dependency + */ Class[] value(); } } diff --git a/src/main/java/com/l2jserver/service/ServiceException.java b/src/main/java/com/l2jserver/service/ServiceException.java index 646e1abd9..8c353a294 100644 --- a/src/main/java/com/l2jserver/service/ServiceException.java +++ b/src/main/java/com/l2jserver/service/ServiceException.java @@ -24,20 +24,46 @@ import com.l2jserver.util.exception.L2Exception; * @author Rogiel */ public abstract class ServiceException extends L2Exception { + /** + * The Java Serialization API serial + */ private static final long serialVersionUID = 1L; - + + /** + * Creates a new instance of this exception + */ public ServiceException() { super(); } + /** + * Creates a new instance of this exception + * + * @param message + * the message + * @param cause + * the root cause + */ public ServiceException(String message, Throwable cause) { super(message, cause); } + /** + * Creates a new instance of this exception + * + * @param message + * the message + */ public ServiceException(String message) { super(message); } + /** + * Creates a new instance of this exception + * + * @param cause + * the root cause + */ public ServiceException(Throwable cause) { super(cause); } diff --git a/src/main/java/com/l2jserver/service/ServiceManager.java b/src/main/java/com/l2jserver/service/ServiceManager.java index a6a26801f..ceb8964bf 100644 --- a/src/main/java/com/l2jserver/service/ServiceManager.java +++ b/src/main/java/com/l2jserver/service/ServiceManager.java @@ -21,6 +21,7 @@ import java.util.Set; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +import com.google.inject.Guice; import com.google.inject.Inject; import com.google.inject.Injector; import com.l2jserver.service.core.LoggingService; @@ -46,6 +47,10 @@ public class ServiceManager { */ private final Set knownServices = CollectionFactory.newSet(); + /** + * @param injector + * the {@link Guice} {@link Injector} + */ @Inject public ServiceManager(Injector injector) { this.injector = injector; @@ -60,10 +65,28 @@ public class ServiceManager { logger = LoggerFactory.getLogger(ServiceManager.class); } + /** + * @param + * the service type + * @param serviceClass + * the service interface Class<T> + * @return the service implementation + */ public T get(Class serviceClass) { return injector.getInstance(serviceClass); } + /** + * Starts the given service implementation + * + * @param + * the service interface type + * @param serviceClass + * the service interface + * @return the service implementation + * @throws ServiceStartException + * if any error occur while starting service + */ public T start(Class serviceClass) throws ServiceStartException { final T service = injector.getInstance(serviceClass); @@ -90,6 +113,14 @@ public class ServiceManager { } } + /** + * Starts the dependencies + * + * @param dependencies + * the dependencies + * @throws ServiceStartException + * if any error occur while starting dependencies + */ private void startDependencies(Class[] dependencies) throws ServiceStartException { if (dependencies == null) @@ -101,6 +132,14 @@ public class ServiceManager { } } + /** + * Stops the given service implementation + * + * @param serviceClass + * the service interface + * @throws ServiceStopException + * if any error occur while stopping service + */ public void stop(Class serviceClass) throws ServiceStopException { final Service service = injector.getInstance(serviceClass); @@ -122,6 +161,14 @@ public class ServiceManager { } } + /** + * Stops the dependencies + * + * @param service + * the service + * @throws ServiceStopException + * if any error occur while stopping dependencies + */ private void stopDependencies(Service service) throws ServiceStopException { final Set> dependencies = createStopDependencies( null, service); @@ -130,6 +177,15 @@ public class ServiceManager { } } + /** + * Creates a {@link Set} of all dependecies to be stopped + * + * @param depends + * the service + * @param serviceClass + * the service class + * @return the {@link Set} of all depedendecies to be stopped + */ private Set> createStopDependencies( Set> depends, Service serviceClass) { if (depends == null) @@ -150,6 +206,17 @@ public class ServiceManager { return depends; } + /** + * Restarts the given service + * + * @param + * the service type + * @param serviceClass + * the service interface + * @return the service implementation + * @throws ServiceException + * if any error occur while starting or stopping the service + */ public T restart(Class serviceClass) throws ServiceException { final T service = injector.getInstance(serviceClass); diff --git a/src/main/java/com/l2jserver/service/ServiceRestartException.java b/src/main/java/com/l2jserver/service/ServiceRestartException.java index 19c14bcb1..2151e1d79 100644 --- a/src/main/java/com/l2jserver/service/ServiceRestartException.java +++ b/src/main/java/com/l2jserver/service/ServiceRestartException.java @@ -23,20 +23,46 @@ package com.l2jserver.service; * @author Rogiel */ public class ServiceRestartException extends ServiceException { + /** + * The Java Serialization API serial + */ private static final long serialVersionUID = 1L; - + + /** + * Creates a new instance of this exception + */ public ServiceRestartException() { super(); } + /** + * Creates a new instance of this exception + * + * @param message + * the message + * @param cause + * the root cause + */ public ServiceRestartException(String message, Throwable cause) { super(message, cause); } + /** + * Creates a new instance of this exception + * + * @param message + * the message + */ public ServiceRestartException(String message) { super(message); } + /** + * Creates a new instance of this exception + * + * @param cause + * the root cause + */ public ServiceRestartException(Throwable cause) { super(cause); } diff --git a/src/main/java/com/l2jserver/service/ServiceStartException.java b/src/main/java/com/l2jserver/service/ServiceStartException.java index 6a5898adf..9864c7027 100644 --- a/src/main/java/com/l2jserver/service/ServiceStartException.java +++ b/src/main/java/com/l2jserver/service/ServiceStartException.java @@ -22,20 +22,46 @@ package com.l2jserver.service; * @author Rogiel */ public class ServiceStartException extends ServiceException { + /** + * The Java Serialization API serial + */ private static final long serialVersionUID = 1L; - + + /** + * Creates a new instance of this exception + */ public ServiceStartException() { super(); } + /** + * Creates a new instance of this exception + * + * @param message + * the message + * @param cause + * the root cause + */ public ServiceStartException(String message, Throwable cause) { super(message, cause); } + /** + * Creates a new instance of this exception + * + * @param message + * the message + */ public ServiceStartException(String message) { super(message); } + /** + * Creates a new instance of this exception + * + * @param cause + * the root cause + */ public ServiceStartException(Throwable cause) { super(cause); } diff --git a/src/main/java/com/l2jserver/service/ServiceStopException.java b/src/main/java/com/l2jserver/service/ServiceStopException.java index bc6531c46..56c907345 100644 --- a/src/main/java/com/l2jserver/service/ServiceStopException.java +++ b/src/main/java/com/l2jserver/service/ServiceStopException.java @@ -22,20 +22,46 @@ package com.l2jserver.service; * @author Rogiel */ public class ServiceStopException extends ServiceException { + /** + * The Java Serialization API serial + */ private static final long serialVersionUID = 1L; - + + /** + * Creates a new instance of this exception + */ public ServiceStopException() { super(); } + /** + * Creates a new instance of this exception + * + * @param message + * the message + * @param cause + * the root cause + */ public ServiceStopException(String message, Throwable cause) { super(message, cause); } + /** + * Creates a new instance of this exception + * + * @param message + * the message + */ public ServiceStopException(String message) { super(message); } + /** + * Creates a new instance of this exception + * + * @param cause + * the root cause + */ public ServiceStopException(Throwable cause) { super(cause); } diff --git a/src/main/java/com/l2jserver/service/cache/AbstractReferenceCache.java b/src/main/java/com/l2jserver/service/cache/AbstractReferenceCache.java index 6c45b060b..ae45ed619 100644 --- a/src/main/java/com/l2jserver/service/cache/AbstractReferenceCache.java +++ b/src/main/java/com/l2jserver/service/cache/AbstractReferenceCache.java @@ -37,6 +37,9 @@ import com.l2jserver.util.factory.CollectionFactory; * the value type */ abstract class AbstractReferenceCache implements Cache { + /** + * The logger + */ protected final Logger log = LoggerFactory.getLogger(this.getClass()); /** @@ -93,6 +96,9 @@ abstract class AbstractReferenceCache implements Cache { return cacheMap.containsKey(key); } + /** + * Cleans the queue + */ protected abstract void cleanQueue(); @Override @@ -131,6 +137,17 @@ abstract class AbstractReferenceCache implements Cache { }; } + /** + * Creates a new reference + * + * @param key + * the reference key + * @param value + * the reference value + * @param queue + * the queue + * @return the new reference + */ protected abstract Reference newReference(K key, V value, ReferenceQueue queue); } diff --git a/src/main/java/com/l2jserver/service/cache/EhCacheService.java b/src/main/java/com/l2jserver/service/cache/EhCacheService.java index ad0fba7f5..eb61f5048 100644 --- a/src/main/java/com/l2jserver/service/cache/EhCacheService.java +++ b/src/main/java/com/l2jserver/service/cache/EhCacheService.java @@ -163,9 +163,25 @@ public class EhCacheService extends AbstractService implements CacheService { interfaceCache = null; } + /** + * {@link net.sf.ehcache.Cache EhCache} facade + * + * @author Rogiel + * + * @param + * the key type + * @param + * the value type + */ private class EhCacheFacade implements Cache { + /** + * The backing cache + */ private final net.sf.ehcache.Cache cache; + /** + * @param cache the backing cache + */ public EhCacheFacade(net.sf.ehcache.Cache cache) { this.cache = cache; } diff --git a/src/main/java/com/l2jserver/service/cache/EternalCache.java b/src/main/java/com/l2jserver/service/cache/EternalCache.java index cab1c1c77..3990b048e 100644 --- a/src/main/java/com/l2jserver/service/cache/EternalCache.java +++ b/src/main/java/com/l2jserver/service/cache/EternalCache.java @@ -36,6 +36,9 @@ import com.l2jserver.util.factory.CollectionFactory; * the value type */ public class EternalCache implements Cache { + /** + * The logger + */ protected final Logger log = LoggerFactory.getLogger(this.getClass()); /** diff --git a/src/main/java/com/l2jserver/service/cache/IgnoreCaching.java b/src/main/java/com/l2jserver/service/cache/IgnoreCaching.java index bc6b64906..92560f6f6 100644 --- a/src/main/java/com/l2jserver/service/cache/IgnoreCaching.java +++ b/src/main/java/com/l2jserver/service/cache/IgnoreCaching.java @@ -22,11 +22,12 @@ import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; +/** + * Indicate to the proxy that this method should not be cached. + * @author Rogiel + */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) @Documented -/** - * Indicate to the proxy that this method should not be cached. - */ public @interface IgnoreCaching { } diff --git a/src/main/java/com/l2jserver/service/cache/MethodInvocation.java b/src/main/java/com/l2jserver/service/cache/MethodInvocation.java index 84a3bb386..b2678a1b0 100644 --- a/src/main/java/com/l2jserver/service/cache/MethodInvocation.java +++ b/src/main/java/com/l2jserver/service/cache/MethodInvocation.java @@ -34,6 +34,10 @@ class MethodInvocation { */ private final Object[] args; + /** + * @param method the method invoked + * @param args the invocation arguments + */ public MethodInvocation(Method method, Object[] args) { this.method = method; this.args = args; diff --git a/src/main/java/com/l2jserver/service/cache/SoftCacheService.java b/src/main/java/com/l2jserver/service/cache/SoftCacheService.java index 879568621..113c072fd 100644 --- a/src/main/java/com/l2jserver/service/cache/SoftCacheService.java +++ b/src/main/java/com/l2jserver/service/cache/SoftCacheService.java @@ -142,18 +142,36 @@ public class SoftCacheService extends AbstractService implements CacheService { * @author Rogiel */ private class SoftEntry extends SoftReference { + /** + * The key + */ private K key; + /** + * @param key + * the key + * @param referent + * the value + * @param q + * the queue + */ SoftEntry(K key, V referent, ReferenceQueue q) { super(referent, q); this.key = key; } + /** + * @return the key + */ K getKey() { return key; } } + /** + * @param cacheName + * the cache name + */ public SoftCache(String cacheName) { super(cacheName); } diff --git a/src/main/java/com/l2jserver/service/cache/WeakCacheService.java b/src/main/java/com/l2jserver/service/cache/WeakCacheService.java index 2a5887b92..75e0b5f5c 100644 --- a/src/main/java/com/l2jserver/service/cache/WeakCacheService.java +++ b/src/main/java/com/l2jserver/service/cache/WeakCacheService.java @@ -130,8 +130,10 @@ public class WeakCacheService extends AbstractService implements CacheService { * if there isn't any strong reference to the value object. * * @author Rogiel - * @param the key type - * @param the value type + * @param + * the key type + * @param + * the value type */ private class WeakCache extends AbstractReferenceCache implements Cache { @@ -142,18 +144,36 @@ public class WeakCacheService extends AbstractService implements CacheService { * @author Rogiel */ private class Entry extends WeakReference { + /** + * The key + */ private K key; + /** + * @param key + * the key + * @param referent + * the value + * @param q + * the queue + */ Entry(K key, V referent, ReferenceQueue q) { super(referent, q); this.key = key; } + /** + * @return the key + */ K getKey() { return key; } } + /** + * @param cacheName + * the cache name + */ WeakCache(String cacheName) { super(cacheName); } diff --git a/src/main/java/com/l2jserver/service/configuration/ProxyConfigurationService.java b/src/main/java/com/l2jserver/service/configuration/ProxyConfigurationService.java index 171262be7..1cc1bba3b 100644 --- a/src/main/java/com/l2jserver/service/configuration/ProxyConfigurationService.java +++ b/src/main/java/com/l2jserver/service/configuration/ProxyConfigurationService.java @@ -103,9 +103,19 @@ public class ProxyConfigurationService extends AbstractService implements * @author Rogiel */ private class ConfigInvocationHandler implements InvocationHandler { + /** + * The invocation handler properties + */ private final Properties properties; + /** + * The invocation cache + */ private Map cache = CollectionFactory.newWeakMap(); + /** + * @param properties + * the properties + */ public ConfigInvocationHandler(Properties properties) { this.properties = properties; } diff --git a/src/main/java/com/l2jserver/service/core/Log4JLoggingService.java b/src/main/java/com/l2jserver/service/core/Log4JLoggingService.java index e5672e2d5..d6b589839 100644 --- a/src/main/java/com/l2jserver/service/core/Log4JLoggingService.java +++ b/src/main/java/com/l2jserver/service/core/Log4JLoggingService.java @@ -34,8 +34,17 @@ import com.l2jserver.service.ServiceStopException; */ public class Log4JLoggingService extends AbstractService implements LoggingService { + /** + * The root logger + */ private Logger rootLogger; + /** + * The l2j logger + */ private Logger l2jLogger; + /** + * The netty logger + */ private Logger nettyLogger; @Override diff --git a/src/main/java/com/l2jserver/service/core/threading/ThreadServiceImpl.java b/src/main/java/com/l2jserver/service/core/threading/ThreadServiceImpl.java index 3e9bea13b..bb17c3358 100644 --- a/src/main/java/com/l2jserver/service/core/threading/ThreadServiceImpl.java +++ b/src/main/java/com/l2jserver/service/core/threading/ThreadServiceImpl.java @@ -19,6 +19,7 @@ package com.l2jserver.service.core.threading; import java.util.concurrent.Callable; import java.util.concurrent.Delayed; import java.util.concurrent.ExecutionException; +import java.util.concurrent.ExecutorService; import java.util.concurrent.Executors; import java.util.concurrent.Future; import java.util.concurrent.ScheduledExecutorService; @@ -85,14 +86,16 @@ public class ThreadServiceImpl extends AbstractService implements ThreadService Preconditions.checkNotNull(unit, "unit"); Preconditions.checkNotNull(task, "task"); - log.debug("Scheduling repeating async task in {}ms each {}ms: {}", new Object[] { - unit.toMillis(delay), unit.toMillis(repeat), task }); + log.debug("Scheduling repeating async task in {}ms each {}ms: {}", + new Object[] { unit.toMillis(delay), unit.toMillis(repeat), + task }); return pool.async(delay, unit, repeat, task); } @Override public ThreadPool createThreadPool(String name, int maxThreads) { - log.debug("Creating new ThreadPool {} with maximum of {} threads", name, maxThreads); + log.debug("Creating new ThreadPool {} with maximum of {} threads", + name, maxThreads); return new ThreadPoolImpl(name, Executors.newScheduledThreadPool(maxThreads)); } @@ -205,9 +208,21 @@ public class ThreadServiceImpl extends AbstractService implements ThreadService } } + /** + * Future implementation for asynchronous tasks + * + * @author Rogiel + */ private class ScheduledAsyncFutureImpl implements ScheduledAsyncFuture { + /** + * The {@link ExecutorService} {@link ScheduledFuture} + */ private final ScheduledFuture future; + /** + * @param future + * the {@link ExecutorService} {@link ScheduledFuture} + */ public ScheduledAsyncFutureImpl(ScheduledFuture future) { this.future = future; } @@ -251,6 +266,11 @@ public class ThreadServiceImpl extends AbstractService implements ThreadService } + /** + * Thread pool implementation + * + * @author Rogiel + */ private class ThreadPoolImpl implements ThreadPool { /** * This thread pool name @@ -261,6 +281,12 @@ public class ThreadServiceImpl extends AbstractService implements ThreadService */ private final ScheduledExecutorService executor; + /** + * @param name + * the pool name + * @param executor + * the backing {@link ScheduledExecutorService} + */ public ThreadPoolImpl(String name, ScheduledExecutorService executor) { this.name = name; this.executor = executor; diff --git a/src/main/java/com/l2jserver/service/core/vfs/Java7VFSService.java b/src/main/java/com/l2jserver/service/core/vfs/Java7VFSService.java index 12b5ec3ae..76036302a 100644 --- a/src/main/java/com/l2jserver/service/core/vfs/Java7VFSService.java +++ b/src/main/java/com/l2jserver/service/core/vfs/Java7VFSService.java @@ -43,6 +43,9 @@ public class Java7VFSService extends AbstractService implements VFSService { */ private final Logger log = LoggerFactory.getLogger(this.getClass()); + /** + * The Java 7 vfs configuration + */ private final Java7VFSConfiguration config; /** @@ -62,6 +65,10 @@ public class Java7VFSService extends AbstractService implements VFSService { public interface Java7VFSConfiguration extends VFSConfiguration { } + /** + * @param configService + * the configuration service + */ @Inject protected Java7VFSService(final ConfigurationService configService) { this.config = configService.get(Java7VFSConfiguration.class); diff --git a/src/main/java/com/l2jserver/service/database/AbstractDAO.java b/src/main/java/com/l2jserver/service/database/AbstractDAO.java index 7d8d19f62..db2973218 100644 --- a/src/main/java/com/l2jserver/service/database/AbstractDAO.java +++ b/src/main/java/com/l2jserver/service/database/AbstractDAO.java @@ -41,6 +41,9 @@ public abstract class AbstractDAO, I extends ID> */ protected final DatabaseService database; + /** + * @param database the database service + */ @Inject protected AbstractDAO(DatabaseService database) { this.database = database; diff --git a/src/main/java/com/l2jserver/service/database/DatabaseService.java b/src/main/java/com/l2jserver/service/database/DatabaseService.java index 2abbb4d32..f0522c412 100644 --- a/src/main/java/com/l2jserver/service/database/DatabaseService.java +++ b/src/main/java/com/l2jserver/service/database/DatabaseService.java @@ -49,6 +49,18 @@ public interface DatabaseService extends Service { public interface DatabaseConfiguration extends ServiceConfiguration { } + /** + * Returns the {@link DataAccessObject} used to retrieve and save objects of + * type + * + * @param + * the {@link Model} type + * @param + * the {@link ID} type + * @param model + * the model class + * @return the {@link DataAccessObject} for {@link Model} + */ , I extends ID> DataAccessObject getDAO( Class model); } diff --git a/src/main/java/com/l2jserver/service/database/JDBCDatabaseService.java b/src/main/java/com/l2jserver/service/database/JDBCDatabaseService.java index 7229a6cbf..e3e26f2c8 100644 --- a/src/main/java/com/l2jserver/service/database/JDBCDatabaseService.java +++ b/src/main/java/com/l2jserver/service/database/JDBCDatabaseService.java @@ -36,6 +36,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; import com.google.common.base.Preconditions; +import com.google.inject.Guice; import com.google.inject.Inject; import com.google.inject.Injector; import com.l2jserver.model.Model; @@ -243,6 +244,16 @@ public class JDBCDatabaseService extends AbstractService implements void setMinIdleConnections(int password); } + /** + * @param configService + * the configuration service + * @param injector + * the {@link Guice} {@link Injector} + * @param cacheService + * the cache service + * @param threadService + * the thread service + */ @Inject public JDBCDatabaseService(ConfigurationService configService, Injector injector, CacheService cacheService, @@ -343,29 +354,57 @@ public class JDBCDatabaseService extends AbstractService implements } } + /** + * Checks for the cached version of the object + * + * @param id + * the object ID + * @return the cached version, if any + */ public Object getCachedObject(Object id) { Preconditions.checkNotNull(id, "id"); log.debug("Fetching cached object {}", id); return objectCache.get(id); } + /** + * Checks for the cached version of the object + * + * @param id + * the object ID + * @return true if has an cached version, + */ public boolean hasCachedObject(Object id) { Preconditions.checkNotNull(id, "id"); log.debug("Locating cached object {}", id); return objectCache.contains(id); } - public void updateCache(ID key, Model value) { - Preconditions.checkNotNull(key, "key"); + /** + * Updates an cache object + * + * @param id + * the cache key + * @param value + * the model value + */ + public void updateCache(ID id, Model value) { + Preconditions.checkNotNull(id, "key"); Preconditions.checkNotNull(value, "value"); - log.debug("Updating cached object {} with {}", key, value); - objectCache.put(key, value); + log.debug("Updating cached object {} with {}", id, value); + objectCache.put(id, value); } - public void removeCache(Object key) { - Preconditions.checkNotNull(key, "key"); - log.debug("Removing cached object {}", key); - objectCache.remove(key); + /** + * Removes an cached object + * + * @param id + * the object id + */ + public void removeCache(Object id) { + Preconditions.checkNotNull(id, "key"); + log.debug("Removing cached object {}", id); + objectCache.remove(id); } @Override @@ -431,6 +470,9 @@ public class JDBCDatabaseService extends AbstractService implements private final Logger log = LoggerFactory .getLogger(InsertUpdateQuery.class); + /** + * The iterator + */ private final Iterator iterator; /** @@ -736,6 +778,9 @@ public class JDBCDatabaseService extends AbstractService implements */ private final JDBCDatabaseService database; + /** + * The {@link ID} mapper + */ private final Mapper idMapper; /** diff --git a/src/main/java/com/l2jserver/service/database/jdbc/AbstractJDBCDAO.java b/src/main/java/com/l2jserver/service/database/jdbc/AbstractJDBCDAO.java index c48c416c3..8356157f0 100644 --- a/src/main/java/com/l2jserver/service/database/jdbc/AbstractJDBCDAO.java +++ b/src/main/java/com/l2jserver/service/database/jdbc/AbstractJDBCDAO.java @@ -40,6 +40,9 @@ public abstract class AbstractJDBCDAO, I extends ID> */ protected final JDBCDatabaseService database; + /** + * @param database the database service + */ @Inject protected AbstractJDBCDAO(DatabaseService database) { super(database); diff --git a/src/main/java/com/l2jserver/service/database/jdbc/JDBCCharacterDAO.java b/src/main/java/com/l2jserver/service/database/jdbc/JDBCCharacterDAO.java index 08553bcd0..c3fc66ac7 100644 --- a/src/main/java/com/l2jserver/service/database/jdbc/JDBCCharacterDAO.java +++ b/src/main/java/com/l2jserver/service/database/jdbc/JDBCCharacterDAO.java @@ -105,6 +105,18 @@ public abstract class JDBCCharacterDAO extends public static final String APPEARANCE_HAIR_COLOR = "appearance_hair_color"; public static final String APPEARANCE_FACE = "apperance_face"; + /** + * @param database + * the database service + * @param idFactory + * the character id provider + * @param templateIdFactory + * the template id provider + * @param accountIdFactory + * the account id provider + * @param clanIdFactory + * the clan id provider + */ @Inject public JDBCCharacterDAO(DatabaseService database, final CharacterIDProvider idFactory, diff --git a/src/main/java/com/l2jserver/service/database/jdbc/JDBCCharacterFriendDAO.java b/src/main/java/com/l2jserver/service/database/jdbc/JDBCCharacterFriendDAO.java index 959802574..84fac44b5 100644 --- a/src/main/java/com/l2jserver/service/database/jdbc/JDBCCharacterFriendDAO.java +++ b/src/main/java/com/l2jserver/service/database/jdbc/JDBCCharacterFriendDAO.java @@ -63,6 +63,11 @@ public abstract class JDBCCharacterFriendDAO extends public static final String CHAR_ID_FRIEND = JDBCCharacterDAO.CHAR_ID + "_friend"; + /** + * @param database the database service + * @param idProvider the frind id provider + * @param charIdProvider the character id provider + */ @Inject public JDBCCharacterFriendDAO(DatabaseService database, final FriendIDProvider idProvider, diff --git a/src/main/java/com/l2jserver/service/database/jdbc/JDBCChatMessageDAO.java b/src/main/java/com/l2jserver/service/database/jdbc/JDBCChatMessageDAO.java index 6809819a6..098e8561f 100644 --- a/src/main/java/com/l2jserver/service/database/jdbc/JDBCChatMessageDAO.java +++ b/src/main/java/com/l2jserver/service/database/jdbc/JDBCChatMessageDAO.java @@ -67,6 +67,14 @@ public abstract class JDBCChatMessageDAO extends public static final String DATE = "date"; public static final String MESSAGE = "message"; + /** + * @param database + * the database service + * @param idFactory + * the chat message id provider + * @param charIdFactory + * the character id provider + */ @Inject public JDBCChatMessageDAO(DatabaseService database, ChatMessageIDProvider idFactory, diff --git a/src/main/java/com/l2jserver/service/database/jdbc/JDBCClanDAO.java b/src/main/java/com/l2jserver/service/database/jdbc/JDBCClanDAO.java index 642e166e2..45be7f18c 100644 --- a/src/main/java/com/l2jserver/service/database/jdbc/JDBCClanDAO.java +++ b/src/main/java/com/l2jserver/service/database/jdbc/JDBCClanDAO.java @@ -61,6 +61,14 @@ public abstract class JDBCClanDAO extends AbstractJDBCDAO public static final String CLAN_ID = "clan_id"; public static final String CHAR_ID_LEADER = "character_id_leader"; + /** + * @param database + * the database service + * @param clanIdFactory + * the clan id provider + * @param idFactory + * the character id provider + */ @Inject public JDBCClanDAO(DatabaseService database, ClanIDProvider clanIdFactory, final CharacterIDProvider idFactory) { diff --git a/src/main/java/com/l2jserver/service/database/jdbc/JDBCItemDAO.java b/src/main/java/com/l2jserver/service/database/jdbc/JDBCItemDAO.java index b29a4e8f4..b88e13527 100644 --- a/src/main/java/com/l2jserver/service/database/jdbc/JDBCItemDAO.java +++ b/src/main/java/com/l2jserver/service/database/jdbc/JDBCItemDAO.java @@ -79,6 +79,12 @@ public abstract class JDBCItemDAO extends AbstractJDBCDAO public static final String COORD_Y = "coord_y"; public static final String COORD_Z = "coord_z"; + /** + * @param database the database service + * @param idFactory the item id provider + * @param templateIdFactory the item template id provider + * @param charIdFactory the character id provider + */ @Inject public JDBCItemDAO(DatabaseService database, final ItemIDProvider idFactory, diff --git a/src/main/java/com/l2jserver/service/database/jdbc/JDBCNPCDAO.java b/src/main/java/com/l2jserver/service/database/jdbc/JDBCNPCDAO.java index a77b7828e..720047010 100644 --- a/src/main/java/com/l2jserver/service/database/jdbc/JDBCNPCDAO.java +++ b/src/main/java/com/l2jserver/service/database/jdbc/JDBCNPCDAO.java @@ -48,6 +48,9 @@ import com.l2jserver.util.geometry.Point3D; */ public abstract class JDBCNPCDAO extends AbstractJDBCDAO implements NPCDAO { + /** + * The logger + */ private final Logger log = LoggerFactory.getLogger(this.getClass()); /** @@ -77,6 +80,14 @@ public abstract class JDBCNPCDAO extends AbstractJDBCDAO implements public static final String RESPAWN_TIME = "respawn_time"; + /** + * @param database + * the database service + * @param idProvider + * the npc id provider + * @param templateIdProvider + * the npc template id provider + */ @Inject public JDBCNPCDAO(DatabaseService database, final NPCIDProvider idProvider, NPCTemplateIDProvider templateIdProvider) { diff --git a/src/main/java/com/l2jserver/service/database/jdbc/h2/H2CharacterDAO.java b/src/main/java/com/l2jserver/service/database/jdbc/h2/H2CharacterDAO.java index c300e741d..a6708213a 100644 --- a/src/main/java/com/l2jserver/service/database/jdbc/h2/H2CharacterDAO.java +++ b/src/main/java/com/l2jserver/service/database/jdbc/h2/H2CharacterDAO.java @@ -31,6 +31,18 @@ import com.l2jserver.service.database.jdbc.JDBCCharacterDAO; * @author Rogiel */ public class H2CharacterDAO extends JDBCCharacterDAO implements CharacterDAO { + /** + * @param database + * the database service + * @param idFactory + * the character id provider + * @param templateIdFactory + * the template id provider + * @param accountIdFactory + * the account id provider + * @param clanIdFactory + * the clan id provider + */ @Inject public H2CharacterDAO(DatabaseService database, CharacterIDProvider idFactory, diff --git a/src/main/java/com/l2jserver/service/database/jdbc/h2/H2CharacterFriendDAO.java b/src/main/java/com/l2jserver/service/database/jdbc/h2/H2CharacterFriendDAO.java index 3b875e79d..0b113c8cf 100644 --- a/src/main/java/com/l2jserver/service/database/jdbc/h2/H2CharacterFriendDAO.java +++ b/src/main/java/com/l2jserver/service/database/jdbc/h2/H2CharacterFriendDAO.java @@ -30,6 +30,11 @@ import com.l2jserver.service.database.jdbc.JDBCCharacterFriendDAO; */ public class H2CharacterFriendDAO extends JDBCCharacterFriendDAO implements CharacterFriendDAO { + /** + * @param database the database service + * @param idProvider the frind id provider + * @param charIdProvider the character id provider + */ @Inject public H2CharacterFriendDAO(DatabaseService database, FriendIDProvider idProvider, CharacterIDProvider charIdProvider) { diff --git a/src/main/java/com/l2jserver/service/database/jdbc/h2/H2ChatMessageDAO.java b/src/main/java/com/l2jserver/service/database/jdbc/h2/H2ChatMessageDAO.java index 52e4eb276..3e6a32c63 100644 --- a/src/main/java/com/l2jserver/service/database/jdbc/h2/H2ChatMessageDAO.java +++ b/src/main/java/com/l2jserver/service/database/jdbc/h2/H2ChatMessageDAO.java @@ -30,6 +30,14 @@ import com.l2jserver.service.database.jdbc.JDBCChatMessageDAO; */ public class H2ChatMessageDAO extends JDBCChatMessageDAO implements ChatMessageDAO { + /** + * @param database + * the database service + * @param idFactory + * the chat message id provider + * @param charIdFactory + * the character id provider + */ @Inject public H2ChatMessageDAO(DatabaseService database, ChatMessageIDProvider idFactory, CharacterIDProvider charIdFactory) { diff --git a/src/main/java/com/l2jserver/service/database/jdbc/h2/H2ClanDAO.java b/src/main/java/com/l2jserver/service/database/jdbc/h2/H2ClanDAO.java index 5f1f83623..ce2d01246 100644 --- a/src/main/java/com/l2jserver/service/database/jdbc/h2/H2ClanDAO.java +++ b/src/main/java/com/l2jserver/service/database/jdbc/h2/H2ClanDAO.java @@ -30,6 +30,14 @@ import com.l2jserver.service.database.jdbc.JDBCClanDAO; * @author Rogiel */ public class H2ClanDAO extends JDBCClanDAO implements ClanDAO { + /** + * @param database + * the database service + * @param clanIdFactory + * the clan id provider + * @param idFactory + * the character id provider + */ @Inject public H2ClanDAO(DatabaseService database, ClanIDProvider clanIdFactory, CharacterIDProvider idFactory) { diff --git a/src/main/java/com/l2jserver/service/database/jdbc/h2/H2ItemDAO.java b/src/main/java/com/l2jserver/service/database/jdbc/h2/H2ItemDAO.java index 77d1037e8..e9b18ab05 100644 --- a/src/main/java/com/l2jserver/service/database/jdbc/h2/H2ItemDAO.java +++ b/src/main/java/com/l2jserver/service/database/jdbc/h2/H2ItemDAO.java @@ -30,6 +30,12 @@ import com.l2jserver.service.database.jdbc.JDBCItemDAO; * @author Rogiel */ public class H2ItemDAO extends JDBCItemDAO implements ItemDAO { + /** + * @param database the database service + * @param idFactory the item id provider + * @param templateIdFactory the item template id provider + * @param charIdFactory the character id provider + */ @Inject public H2ItemDAO(DatabaseService database, ItemIDProvider idFactory, ItemTemplateIDProvider templateIdFactory, diff --git a/src/main/java/com/l2jserver/service/database/jdbc/h2/H2NPCDAO.java b/src/main/java/com/l2jserver/service/database/jdbc/h2/H2NPCDAO.java index 28ee53de2..804d3ca4c 100644 --- a/src/main/java/com/l2jserver/service/database/jdbc/h2/H2NPCDAO.java +++ b/src/main/java/com/l2jserver/service/database/jdbc/h2/H2NPCDAO.java @@ -30,6 +30,11 @@ import com.l2jserver.service.database.jdbc.JDBCNPCDAO; * @author Rogiel */ public class H2NPCDAO extends JDBCNPCDAO implements NPCDAO { + /** + * @param database the database service + * @param idProvider the npc id provider + * @param templateIdProvider the npc template id provider + */ @Inject public H2NPCDAO(DatabaseService database, NPCIDProvider idProvider, NPCTemplateIDProvider templateIdProvider) { diff --git a/src/main/java/com/l2jserver/service/database/jdbc/mysql5/MySQL5CharacterDAO.java b/src/main/java/com/l2jserver/service/database/jdbc/mysql5/MySQL5CharacterDAO.java index 2c34bd11b..8aa04a95e 100644 --- a/src/main/java/com/l2jserver/service/database/jdbc/mysql5/MySQL5CharacterDAO.java +++ b/src/main/java/com/l2jserver/service/database/jdbc/mysql5/MySQL5CharacterDAO.java @@ -32,6 +32,18 @@ import com.l2jserver.service.database.jdbc.JDBCCharacterDAO; */ public class MySQL5CharacterDAO extends JDBCCharacterDAO implements CharacterDAO { + /** + * @param database + * the database service + * @param idFactory + * the character id provider + * @param templateIdFactory + * the template id provider + * @param accountIdFactory + * the account id provider + * @param clanIdFactory + * the clan id provider + */ @Inject public MySQL5CharacterDAO(DatabaseService database, CharacterIDProvider idFactory, diff --git a/src/main/java/com/l2jserver/service/database/jdbc/mysql5/MySQL5CharacterFriendDAO.java b/src/main/java/com/l2jserver/service/database/jdbc/mysql5/MySQL5CharacterFriendDAO.java index ea2b4958f..0471e4010 100644 --- a/src/main/java/com/l2jserver/service/database/jdbc/mysql5/MySQL5CharacterFriendDAO.java +++ b/src/main/java/com/l2jserver/service/database/jdbc/mysql5/MySQL5CharacterFriendDAO.java @@ -30,6 +30,11 @@ import com.l2jserver.service.database.jdbc.JDBCCharacterFriendDAO; */ public class MySQL5CharacterFriendDAO extends JDBCCharacterFriendDAO implements CharacterFriendDAO { + /** + * @param database the database service + * @param idProvider the frind id provider + * @param charIdProvider the character id provider + */ @Inject public MySQL5CharacterFriendDAO(DatabaseService database, FriendIDProvider idProvider, CharacterIDProvider charIdProvider) { diff --git a/src/main/java/com/l2jserver/service/database/jdbc/mysql5/MySQL5ChatMessageDAO.java b/src/main/java/com/l2jserver/service/database/jdbc/mysql5/MySQL5ChatMessageDAO.java index b76a00ade..4dfe3edf0 100644 --- a/src/main/java/com/l2jserver/service/database/jdbc/mysql5/MySQL5ChatMessageDAO.java +++ b/src/main/java/com/l2jserver/service/database/jdbc/mysql5/MySQL5ChatMessageDAO.java @@ -30,6 +30,14 @@ import com.l2jserver.service.database.jdbc.JDBCChatMessageDAO; */ public class MySQL5ChatMessageDAO extends JDBCChatMessageDAO implements ChatMessageDAO { + /** + * @param database + * the database service + * @param idFactory + * the chat message id provider + * @param charIdFactory + * the character id provider + */ @Inject public MySQL5ChatMessageDAO(DatabaseService database, ChatMessageIDProvider idFactory, CharacterIDProvider charIdFactory) { diff --git a/src/main/java/com/l2jserver/service/database/jdbc/mysql5/MySQL5ClanDAO.java b/src/main/java/com/l2jserver/service/database/jdbc/mysql5/MySQL5ClanDAO.java index 1f4800cc7..e5e1d48eb 100644 --- a/src/main/java/com/l2jserver/service/database/jdbc/mysql5/MySQL5ClanDAO.java +++ b/src/main/java/com/l2jserver/service/database/jdbc/mysql5/MySQL5ClanDAO.java @@ -30,6 +30,14 @@ import com.l2jserver.service.database.jdbc.JDBCClanDAO; * @author Rogiel */ public class MySQL5ClanDAO extends JDBCClanDAO implements ClanDAO { + /** + * @param database + * the database service + * @param clanIdFactory + * the clan id provider + * @param idFactory + * the character id provider + */ @Inject public MySQL5ClanDAO(DatabaseService database, ClanIDProvider clanIdFactory, CharacterIDProvider idFactory) { diff --git a/src/main/java/com/l2jserver/service/database/jdbc/mysql5/MySQL5ItemDAO.java b/src/main/java/com/l2jserver/service/database/jdbc/mysql5/MySQL5ItemDAO.java index 2da78f4b6..bf636e7da 100644 --- a/src/main/java/com/l2jserver/service/database/jdbc/mysql5/MySQL5ItemDAO.java +++ b/src/main/java/com/l2jserver/service/database/jdbc/mysql5/MySQL5ItemDAO.java @@ -30,6 +30,12 @@ import com.l2jserver.service.database.jdbc.JDBCItemDAO; * @author Rogiel */ public class MySQL5ItemDAO extends JDBCItemDAO implements ItemDAO { + /** + * @param database the database service + * @param idFactory the item id provider + * @param templateIdFactory the item template id provider + * @param charIdFactory the character id provider + */ @Inject public MySQL5ItemDAO(DatabaseService database, ItemIDProvider idFactory, ItemTemplateIDProvider templateIdFactory, diff --git a/src/main/java/com/l2jserver/service/database/jdbc/mysql5/MySQL5NPCDAO.java b/src/main/java/com/l2jserver/service/database/jdbc/mysql5/MySQL5NPCDAO.java index fd6a1dfdd..496b599fe 100644 --- a/src/main/java/com/l2jserver/service/database/jdbc/mysql5/MySQL5NPCDAO.java +++ b/src/main/java/com/l2jserver/service/database/jdbc/mysql5/MySQL5NPCDAO.java @@ -30,6 +30,11 @@ import com.l2jserver.service.database.jdbc.JDBCNPCDAO; * @author Rogiel */ public class MySQL5NPCDAO extends JDBCNPCDAO implements NPCDAO { + /** + * @param database the database service + * @param idProvider the npc id provider + * @param templateIdProvider the npc template id provider + */ @Inject public MySQL5NPCDAO(DatabaseService database, NPCIDProvider idProvider, NPCTemplateIDProvider templateIdProvider) { diff --git a/src/main/java/com/l2jserver/service/game/AttackServiceImpl.java b/src/main/java/com/l2jserver/service/game/AttackServiceImpl.java index 9e532d533..72dc67573 100644 --- a/src/main/java/com/l2jserver/service/game/AttackServiceImpl.java +++ b/src/main/java/com/l2jserver/service/game/AttackServiceImpl.java @@ -68,6 +68,11 @@ public class AttackServiceImpl extends AbstractService implements AttackService */ private final WorldEventDispatcher eventDispatcher; + /** + * @param threadService the thread service + * @param npcService the npc service + * @param eventDispatcher the world service event dispatcher + */ @Inject public AttackServiceImpl(ThreadService threadService, NPCService npcService, WorldEventDispatcher eventDispatcher) { @@ -101,6 +106,10 @@ public class AttackServiceImpl extends AbstractService implements AttackService */ private final Actor target; + /** + * @param attacker the attacker + * @param target the target + */ public AttackCallable(Actor attacker, Actor target) { this.attacker = attacker; this.target = target; diff --git a/src/main/java/com/l2jserver/service/game/admin/AdministratorService.java b/src/main/java/com/l2jserver/service/game/admin/AdministratorService.java index 9cb5c3595..0b0641a61 100644 --- a/src/main/java/com/l2jserver/service/game/admin/AdministratorService.java +++ b/src/main/java/com/l2jserver/service/game/admin/AdministratorService.java @@ -47,6 +47,12 @@ public interface AdministratorService extends Service { * @author Rogiel */ public interface AdministratorCommand { + /** + * @param character + * the administrator character + * @param args + * the arguments + */ void administrator(L2Character character, String... args); } } diff --git a/src/main/java/com/l2jserver/service/game/admin/AdministratorServiceImpl.java b/src/main/java/com/l2jserver/service/game/admin/AdministratorServiceImpl.java index d29626161..c8cab7417 100644 --- a/src/main/java/com/l2jserver/service/game/admin/AdministratorServiceImpl.java +++ b/src/main/java/com/l2jserver/service/game/admin/AdministratorServiceImpl.java @@ -38,7 +38,10 @@ public class AdministratorServiceImpl extends AbstractService implements * The logger */ private final Logger log = LoggerFactory.getLogger(this.getClass()); - + + /** + * List of online administrators + */ @SuppressWarnings("unused") private List online; diff --git a/src/main/java/com/l2jserver/service/game/admin/GMService.java b/src/main/java/com/l2jserver/service/game/admin/GMService.java index 825bdeb29..0313b777d 100644 --- a/src/main/java/com/l2jserver/service/game/admin/GMService.java +++ b/src/main/java/com/l2jserver/service/game/admin/GMService.java @@ -25,9 +25,30 @@ import com.l2jserver.service.Service; * @author Rogiel */ public interface GMService extends Service { + /** + * Executes an GM command + * + * @param character + * the GM character + * @param command + * the command + * @param args + * the command arguments + */ void command(L2Character character, String command, String... args); + /** + * The base interface for GM commands + * + * @author Rogiel + */ public interface GMCommand { + /** + * @param character + * the GM character + * @param args + * the command arguments + */ void gm(L2Character character, String... args); } } diff --git a/src/main/java/com/l2jserver/service/game/ai/AIServiceImpl.java b/src/main/java/com/l2jserver/service/game/ai/AIServiceImpl.java index e7d078c1f..f0ad3edf0 100644 --- a/src/main/java/com/l2jserver/service/game/ai/AIServiceImpl.java +++ b/src/main/java/com/l2jserver/service/game/ai/AIServiceImpl.java @@ -45,7 +45,7 @@ public class AIServiceImpl extends AbstractService implements AIService { */ @SuppressWarnings("unused") private final Logger log = LoggerFactory.getLogger(this.getClass()); - + /** * The {@link WorldService} */ @@ -67,6 +67,16 @@ public class AIServiceImpl extends AbstractService implements AIService { @SuppressWarnings("unused") private final NetworkService networkService; + /** + * @param worldService + * the world service + * @param eventDispatcher + * the world service event dispatcher + * @param threadService + * the thread service + * @param networkService + * the network service + */ @Inject public AIServiceImpl(WorldService worldService, WorldEventDispatcher eventDispatcher, ThreadService threadService, diff --git a/src/main/java/com/l2jserver/service/game/character/ActorIsNotAttackableServiceException.java b/src/main/java/com/l2jserver/service/game/character/ActorIsNotAttackableServiceException.java index 4119ac1a4..755c5e94f 100644 --- a/src/main/java/com/l2jserver/service/game/character/ActorIsNotAttackableServiceException.java +++ b/src/main/java/com/l2jserver/service/game/character/ActorIsNotAttackableServiceException.java @@ -26,5 +26,8 @@ import com.l2jserver.model.world.Actor; */ public class ActorIsNotAttackableServiceException extends CharacterServiceException { + /** + * The Java Serialization API serial + */ private static final long serialVersionUID = 1L; } \ No newline at end of file diff --git a/src/main/java/com/l2jserver/service/game/character/CannotSetTargetServiceException.java b/src/main/java/com/l2jserver/service/game/character/CannotSetTargetServiceException.java index dd9e97e5b..ad6eab09e 100644 --- a/src/main/java/com/l2jserver/service/game/character/CannotSetTargetServiceException.java +++ b/src/main/java/com/l2jserver/service/game/character/CannotSetTargetServiceException.java @@ -22,5 +22,8 @@ package com.l2jserver.service.game.character; * @author Rogiel */ public class CannotSetTargetServiceException extends CharacterServiceException { + /** + * The Java Serialization API serial + */ private static final long serialVersionUID = 1L; } \ No newline at end of file diff --git a/src/main/java/com/l2jserver/service/game/character/CharacterAlreadyRunningServiceException.java b/src/main/java/com/l2jserver/service/game/character/CharacterAlreadyRunningServiceException.java index 60daa2014..1e2c1ec2f 100644 --- a/src/main/java/com/l2jserver/service/game/character/CharacterAlreadyRunningServiceException.java +++ b/src/main/java/com/l2jserver/service/game/character/CharacterAlreadyRunningServiceException.java @@ -23,5 +23,7 @@ package com.l2jserver.service.game.character; */ public class CharacterAlreadyRunningServiceException extends CharacterServiceException { - private static final long serialVersionUID = 1L; -} \ No newline at end of file + /** + * The Java Serialization API serial + */ + private static final long serialVersionUID = 1L;} \ No newline at end of file diff --git a/src/main/java/com/l2jserver/service/game/character/CharacterAlreadyWalkingServiceException.java b/src/main/java/com/l2jserver/service/game/character/CharacterAlreadyWalkingServiceException.java index f25d5e5b3..0bb1d1d32 100644 --- a/src/main/java/com/l2jserver/service/game/character/CharacterAlreadyWalkingServiceException.java +++ b/src/main/java/com/l2jserver/service/game/character/CharacterAlreadyWalkingServiceException.java @@ -23,5 +23,7 @@ package com.l2jserver.service.game.character; */ public class CharacterAlreadyWalkingServiceException extends CharacterServiceException { - private static final long serialVersionUID = 1L; -} \ No newline at end of file + /** + * The Java Serialization API serial + */ + private static final long serialVersionUID = 1L;} \ No newline at end of file diff --git a/src/main/java/com/l2jserver/service/game/character/CharacterInJailServiceException.java b/src/main/java/com/l2jserver/service/game/character/CharacterInJailServiceException.java index b5ea68d51..2d40dcdb5 100644 --- a/src/main/java/com/l2jserver/service/game/character/CharacterInJailServiceException.java +++ b/src/main/java/com/l2jserver/service/game/character/CharacterInJailServiceException.java @@ -22,5 +22,7 @@ package com.l2jserver.service.game.character; * @author Rogiel */ public class CharacterInJailServiceException extends CharacterServiceException { - private static final long serialVersionUID = 1L; -} \ No newline at end of file + /** + * The Java Serialization API serial + */ + private static final long serialVersionUID = 1L;} \ No newline at end of file diff --git a/src/main/java/com/l2jserver/service/game/character/CharacterInvalidAppearanceException.java b/src/main/java/com/l2jserver/service/game/character/CharacterInvalidAppearanceException.java index 36016de31..ade488b8e 100644 --- a/src/main/java/com/l2jserver/service/game/character/CharacterInvalidAppearanceException.java +++ b/src/main/java/com/l2jserver/service/game/character/CharacterInvalidAppearanceException.java @@ -23,5 +23,8 @@ package com.l2jserver.service.game.character; */ public class CharacterInvalidAppearanceException extends CharacterServiceException { + /** + * The Java Serialization API serial + */ private static final long serialVersionUID = 1L; } \ No newline at end of file diff --git a/src/main/java/com/l2jserver/service/game/character/CharacterInvalidNameException.java b/src/main/java/com/l2jserver/service/game/character/CharacterInvalidNameException.java index 8410f5a4d..6eb2ca8db 100644 --- a/src/main/java/com/l2jserver/service/game/character/CharacterInvalidNameException.java +++ b/src/main/java/com/l2jserver/service/game/character/CharacterInvalidNameException.java @@ -23,5 +23,7 @@ package com.l2jserver.service.game.character; */ public class CharacterInvalidNameException extends CharacterServiceException { - private static final long serialVersionUID = 1L; -} \ No newline at end of file + /** + * The Java Serialization API serial + */ + private static final long serialVersionUID = 1L;} \ No newline at end of file diff --git a/src/main/java/com/l2jserver/service/game/character/CharacterNameAlreadyExistsException.java b/src/main/java/com/l2jserver/service/game/character/CharacterNameAlreadyExistsException.java index 7212ea779..cbe5d412d 100644 --- a/src/main/java/com/l2jserver/service/game/character/CharacterNameAlreadyExistsException.java +++ b/src/main/java/com/l2jserver/service/game/character/CharacterNameAlreadyExistsException.java @@ -23,5 +23,7 @@ package com.l2jserver.service.game.character; */ public class CharacterNameAlreadyExistsException extends CharacterServiceException { - private static final long serialVersionUID = 1L; -} \ No newline at end of file + /** + * The Java Serialization API serial + */ + private static final long serialVersionUID = 1L;} \ No newline at end of file diff --git a/src/main/java/com/l2jserver/service/game/character/CharacterNotInJailServiceException.java b/src/main/java/com/l2jserver/service/game/character/CharacterNotInJailServiceException.java index 210522ed1..e7197bb8e 100644 --- a/src/main/java/com/l2jserver/service/game/character/CharacterNotInJailServiceException.java +++ b/src/main/java/com/l2jserver/service/game/character/CharacterNotInJailServiceException.java @@ -23,5 +23,7 @@ package com.l2jserver.service.game.character; */ public class CharacterNotInJailServiceException extends CharacterServiceException { - private static final long serialVersionUID = 1L; -} \ No newline at end of file + /** + * The Java Serialization API serial + */ + private static final long serialVersionUID = 1L;} \ No newline at end of file diff --git a/src/main/java/com/l2jserver/service/game/character/CharacterServiceException.java b/src/main/java/com/l2jserver/service/game/character/CharacterServiceException.java index 90c5f6068..cee2df35a 100644 --- a/src/main/java/com/l2jserver/service/game/character/CharacterServiceException.java +++ b/src/main/java/com/l2jserver/service/game/character/CharacterServiceException.java @@ -22,20 +22,46 @@ import com.l2jserver.service.ServiceException; * @author Rogiel */ public class CharacterServiceException extends ServiceException { + /** + * The Java Serialization API serial + */ private static final long serialVersionUID = 1L; - + + /** + * Creates a new instance of this exception + */ public CharacterServiceException() { super(); } + /** + * Creates a new instance of this exception + * + * @param message + * the message + * @param cause + * the root cause + */ public CharacterServiceException(String message, Throwable cause) { super(message, cause); } + /** + * Creates a new instance of this exception + * + * @param message + * the message + */ public CharacterServiceException(String message) { super(message); } + /** + * Creates a new instance of this exception + * + * @param cause + * the root cause + */ public CharacterServiceException(Throwable cause) { super(cause); } diff --git a/src/main/java/com/l2jserver/service/game/character/CharacterServiceImpl.java b/src/main/java/com/l2jserver/service/game/character/CharacterServiceImpl.java index eebb430ee..a780c31eb 100644 --- a/src/main/java/com/l2jserver/service/game/character/CharacterServiceImpl.java +++ b/src/main/java/com/l2jserver/service/game/character/CharacterServiceImpl.java @@ -133,7 +133,13 @@ public class CharacterServiceImpl extends AbstractService implements */ private final ItemDAO itemDao; + /** + * The character ID provider + */ private final CharacterIDProvider charIdProvider; + /** + * The character template ID provider + */ private final CharacterTemplateIDProvider charTemplateIdProvider; // /** @@ -141,6 +147,30 @@ public class CharacterServiceImpl extends AbstractService implements // */ // private final AIService aiService; + /** + * @param broadcastService + * the broadcast service + * @param eventDispatcher + * the world service event dispatcher + * @param chatService + * the chat service + * @param networkService + * the network service + * @param spawnService + * the spawn service + * @param npcService + * the npc service + * @param ggService + * the gm service + * @param characterDao + * the character DAO + * @param itemDao + * the item DAO + * @param charTemplateIdProvider + * the character template id provider + * @param charIdProvider + * the character id provider + */ @Inject public CharacterServiceImpl(BroadcastService broadcastService, WorldEventDispatcher eventDispatcher, ChatService chatService, @@ -433,9 +463,9 @@ public class CharacterServiceImpl extends AbstractService implements public void move(L2Character character, Coordinate coordinate) { Preconditions.checkNotNull(character, "character"); Preconditions.checkNotNull(coordinate, "coordinate"); - + log.debug("{} is moving to {}", character, coordinate); - + final CharacterID id = character.getID(); final Lineage2Client conn = networkService.discover(id); // we don't set the character coordinate here, this will be done by @@ -467,9 +497,10 @@ public class CharacterServiceImpl extends AbstractService implements // ignore while teleporting, for some reason the client sends a // validation just before teleport packet return; - - log.debug("{} client is validating its position to {}", character, point); - + + log.debug("{} client is validating its position to {}", character, + point); + final Point3D old = character.getPoint(); character.setPoint(point); // BroadcastService will catch this event and update the knownlist @@ -492,9 +523,9 @@ public class CharacterServiceImpl extends AbstractService implements // test if character is running if (character.getMoveType() == CharacterMoveType.WALK) throw new CharacterAlreadyWalkingServiceException(); - + log.debug("{} move type is being set to WALK", character); - + // if running set mode to walk and broadcast packet character.setMoveType(CharacterMoveType.WALK); @@ -511,9 +542,9 @@ public class CharacterServiceImpl extends AbstractService implements // test if character is walking if (character.getMoveType() == CharacterMoveType.RUN) throw new CharacterAlreadyRunningServiceException(); - + log.debug("{} move type is being set to RUN", character); - + // if running walking mode to run and broadcast packet character.setMoveType(CharacterMoveType.RUN); diff --git a/src/main/java/com/l2jserver/service/game/chat/CannotChatToSelfChatServiceException.java b/src/main/java/com/l2jserver/service/game/chat/CannotChatToSelfChatServiceException.java index f2e9245c4..de1e4a602 100644 --- a/src/main/java/com/l2jserver/service/game/chat/CannotChatToSelfChatServiceException.java +++ b/src/main/java/com/l2jserver/service/game/chat/CannotChatToSelfChatServiceException.java @@ -22,5 +22,8 @@ package com.l2jserver.service.game.chat; * @author Rogiel */ public class CannotChatToSelfChatServiceException extends ChatServiceException { + /** + * The Java Serialization API serial + */ private static final long serialVersionUID = 1L; } \ No newline at end of file diff --git a/src/main/java/com/l2jserver/service/game/chat/ChatBanActiveChatServiceException.java b/src/main/java/com/l2jserver/service/game/chat/ChatBanActiveChatServiceException.java index 7665a5fad..422f18d46 100644 --- a/src/main/java/com/l2jserver/service/game/chat/ChatBanActiveChatServiceException.java +++ b/src/main/java/com/l2jserver/service/game/chat/ChatBanActiveChatServiceException.java @@ -22,5 +22,8 @@ package com.l2jserver.service.game.chat; * @author Rogiel */ public class ChatBanActiveChatServiceException extends ChatServiceException { + /** + * The Java Serialization API serial + */ private static final long serialVersionUID = 1L; } \ No newline at end of file diff --git a/src/main/java/com/l2jserver/service/game/chat/ChatMessageType.java b/src/main/java/com/l2jserver/service/game/chat/ChatMessageType.java index 357ed56cb..64cc6a31e 100644 --- a/src/main/java/com/l2jserver/service/game/chat/ChatMessageType.java +++ b/src/main/java/com/l2jserver/service/game/chat/ChatMessageType.java @@ -41,7 +41,19 @@ public enum ChatMessageType { /** * \@ */ - CLAN(4), GM(5), PETITION_PLAYER(6), PETITION_GM(7), + CLAN(4), + /** + * The GM chat + */ + GM(5), + /** + * Petition system: player messages + */ + PETITION_PLAYER(6), + /** + * Petition system: GM messages + */ + PETITION_GM(7), /** * + */ @@ -61,12 +73,26 @@ public enum ChatMessageType { 15), PARTYROOM_ALL(16), HERO_VOICE(17), CRITICAL_ANNOUNCE(18), SCREEN_ANNOUNCE( 19), BATTLEFIELD(20), MPCC_ROOM(21); + /** + * The numeric id representing this message type + */ public final int id; + /** + * @param id + * the numeric id for this message type + */ ChatMessageType(int id) { this.id = id; } + /** + * Resolves the numeric ID to {@link ChatMessageType} java type. + * + * @param id + * the numeric id + * @return the {@link ChatMessageType} resolved. Can be null. + */ public static ChatMessageType fromID(int id) { for (final ChatMessageType dest : values()) { if (dest.id == id) diff --git a/src/main/java/com/l2jserver/service/game/chat/ChatServiceException.java b/src/main/java/com/l2jserver/service/game/chat/ChatServiceException.java index 2311ebe1a..3071693b5 100644 --- a/src/main/java/com/l2jserver/service/game/chat/ChatServiceException.java +++ b/src/main/java/com/l2jserver/service/game/chat/ChatServiceException.java @@ -22,20 +22,46 @@ import com.l2jserver.service.ServiceException; * @author Rogiel */ public class ChatServiceException extends ServiceException { + /** + * The Java Serialization API serial + */ private static final long serialVersionUID = 1L; + /** + * Creates a new instance of this exception + */ public ChatServiceException() { super(); } + /** + * Creates a new instance of this exception + * + * @param message + * the message + * @param cause + * the root cause + */ public ChatServiceException(String message, Throwable cause) { super(message, cause); } + /** + * Creates a new instance of this exception + * + * @param message + * the message + */ public ChatServiceException(String message) { super(message); } + /** + * Creates a new instance of this exception + * + * @param cause + * the root cause + */ public ChatServiceException(Throwable cause) { super(cause); } diff --git a/src/main/java/com/l2jserver/service/game/chat/ChatTargetOfflineServiceException.java b/src/main/java/com/l2jserver/service/game/chat/ChatTargetOfflineServiceException.java index e2a1e5c6e..d51aaac8a 100644 --- a/src/main/java/com/l2jserver/service/game/chat/ChatTargetOfflineServiceException.java +++ b/src/main/java/com/l2jserver/service/game/chat/ChatTargetOfflineServiceException.java @@ -23,5 +23,8 @@ package com.l2jserver.service.game.chat; * @author Rogiel */ public class ChatTargetOfflineServiceException extends ChatServiceException { + /** + * The Java Serialization API serial + */ private static final long serialVersionUID = 1L; } \ No newline at end of file diff --git a/src/main/java/com/l2jserver/service/game/chat/DatabaseChatLoggingService.java b/src/main/java/com/l2jserver/service/game/chat/DatabaseChatLoggingService.java index 94dc684f8..3d4980321 100644 --- a/src/main/java/com/l2jserver/service/game/chat/DatabaseChatLoggingService.java +++ b/src/main/java/com/l2jserver/service/game/chat/DatabaseChatLoggingService.java @@ -44,6 +44,10 @@ public class DatabaseChatLoggingService extends AbstractService implements */ private final CharacterIDProvider charIdProvider; + /** + * @param chatMessageDao the chat message DAO + * @param charIdProvider the character id provider + */ @Inject protected DatabaseChatLoggingService(ChatMessageDAO chatMessageDao, CharacterIDProvider charIdProvider) { diff --git a/src/main/java/com/l2jserver/service/game/chat/SimpleChatService.java b/src/main/java/com/l2jserver/service/game/chat/SimpleChatService.java index 46af6ab0a..d641632f4 100644 --- a/src/main/java/com/l2jserver/service/game/chat/SimpleChatService.java +++ b/src/main/java/com/l2jserver/service/game/chat/SimpleChatService.java @@ -323,8 +323,14 @@ public class SimpleChatService extends AbstractService implements ChatService { */ private class PrivateChatChannelImpl extends ChatChannelImpl implements PrivateChatChannel { + /** + * The target character {@link ID} + */ private final CharacterID character; + /** + * @param character the target character {@link ID} + */ public PrivateChatChannelImpl(CharacterID character) { Preconditions.checkNotNull(character, "character"); this.character = character; diff --git a/src/main/java/com/l2jserver/service/game/chat/TargetNotFoundChatServiceException.java b/src/main/java/com/l2jserver/service/game/chat/TargetNotFoundChatServiceException.java index fe851c65f..d967b8c05 100644 --- a/src/main/java/com/l2jserver/service/game/chat/TargetNotFoundChatServiceException.java +++ b/src/main/java/com/l2jserver/service/game/chat/TargetNotFoundChatServiceException.java @@ -22,5 +22,8 @@ package com.l2jserver.service.game.chat; * @author Rogiel */ public class TargetNotFoundChatServiceException extends ChatServiceException { + /** + * The Java Serialization API serial + */ private static final long serialVersionUID = 1L; } \ No newline at end of file diff --git a/src/main/java/com/l2jserver/service/game/clan/ClanService.java b/src/main/java/com/l2jserver/service/game/clan/ClanService.java index 175443937..e6dbc6389 100644 --- a/src/main/java/com/l2jserver/service/game/clan/ClanService.java +++ b/src/main/java/com/l2jserver/service/game/clan/ClanService.java @@ -26,7 +26,26 @@ import com.l2jserver.service.Service; * @author Rogiel */ public interface ClanService extends Service { + /** + * Joins the character on the given clan + * + * @param clan + * the clan + * @param character + * the character (joinee) + * @param inviter + * the character inviting character to this + * clan, if any. + */ void join(Clan clan, L2Character character, L2Character inviter); + /** + * Removes the character from the given clan + * + * @param clan + * the clan + * @param character + * the character (leaver) + */ void leave(Clan clan, L2Character character); } diff --git a/src/main/java/com/l2jserver/service/game/map/Tile.java b/src/main/java/com/l2jserver/service/game/map/Tile.java index 9482db893..0a2a8c4cb 100644 --- a/src/main/java/com/l2jserver/service/game/map/Tile.java +++ b/src/main/java/com/l2jserver/service/game/map/Tile.java @@ -24,9 +24,19 @@ import com.l2jserver.util.geometry.Point; * @author Rogiel */ public class Tile { + /** + * The tile point + */ private final Point point; + /** + * The tile flags + */ private final byte flags; + /** + * @param point the file point + * @param flags the tile flags + */ public Tile(Point point, byte flags) { this.point = point; this.flags = flags; diff --git a/src/main/java/com/l2jserver/service/game/map/pathing/MapperPathingService.java b/src/main/java/com/l2jserver/service/game/map/pathing/MapperPathingService.java index e007b1188..0b550b44e 100644 --- a/src/main/java/com/l2jserver/service/game/map/pathing/MapperPathingService.java +++ b/src/main/java/com/l2jserver/service/game/map/pathing/MapperPathingService.java @@ -138,10 +138,28 @@ public class MapperPathingService extends AbstractService implements * @author Rogiel */ public static class CoordinateStruct extends Struct { + /** + * The x cord + */ public final Signed32 x = new Signed32(); + /** + * The y cord + */ public final Signed32 y = new Signed32(); + /** + * The z cord + */ public final Signed32 z = new Signed32(); + /** + * Creates a new Coordinate Struct from another {@link Coordinate} + * object + * + * @param coordinate + * the coordinate object + * @return the {@link CoordinateStruct} object with the same coordinates + * as coordinate + */ public static CoordinateStruct fromCoordinate(Coordinate coordinate) { final CoordinateStruct struct = new CoordinateStruct(); struct.x.set(coordinate.getX()); @@ -157,9 +175,19 @@ public class MapperPathingService extends AbstractService implements * @author Rogiel */ private class VoidPath implements Path { + /** + * The source point + */ private final Point3D source; + /** + * The target point + */ private final Point3D target; + /** + * @param source the source point + * @param target the taget point + */ public VoidPath(Point3D source, Point3D target) { this.source = source; this.target = target; diff --git a/src/main/java/com/l2jserver/service/game/npc/ActionServiceException.java b/src/main/java/com/l2jserver/service/game/npc/ActionServiceException.java index b4fae8337..09779af74 100644 --- a/src/main/java/com/l2jserver/service/game/npc/ActionServiceException.java +++ b/src/main/java/com/l2jserver/service/game/npc/ActionServiceException.java @@ -25,6 +25,9 @@ import com.l2jserver.util.exception.L2Exception; * @author Rogiel */ public class ActionServiceException extends NPCServiceException { + /** + * The Java Serialization API serial + */ private static final long serialVersionUID = 1L; /** diff --git a/src/main/java/com/l2jserver/service/game/npc/NPCServiceException.java b/src/main/java/com/l2jserver/service/game/npc/NPCServiceException.java index 9a4b9d959..e5e86cd74 100644 --- a/src/main/java/com/l2jserver/service/game/npc/NPCServiceException.java +++ b/src/main/java/com/l2jserver/service/game/npc/NPCServiceException.java @@ -22,20 +22,46 @@ import com.l2jserver.service.ServiceException; * @author Rogiel */ public class NPCServiceException extends ServiceException { + /** + * The Java Serialization API serial + */ private static final long serialVersionUID = 1L; + /** + * Creates a new instance of this exception + */ public NPCServiceException() { super(); } + /** + * Creates a new instance of this exception + * + * @param message + * the message + * @param cause + * the root cause + */ public NPCServiceException(String message, Throwable cause) { super(message, cause); } + /** + * Creates a new instance of this exception + * + * @param message + * the message + */ public NPCServiceException(String message) { super(message); } + /** + * Creates a new instance of this exception + * + * @param cause + * the root cause + */ public NPCServiceException(Throwable cause) { super(cause); } diff --git a/src/main/java/com/l2jserver/service/game/npc/NPCServiceImpl.java b/src/main/java/com/l2jserver/service/game/npc/NPCServiceImpl.java index e4cf7117d..78a9e251f 100644 --- a/src/main/java/com/l2jserver/service/game/npc/NPCServiceImpl.java +++ b/src/main/java/com/l2jserver/service/game/npc/NPCServiceImpl.java @@ -26,6 +26,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; import com.google.common.base.Preconditions; +import com.google.inject.Guice; import com.google.inject.Inject; import com.google.inject.Injector; import com.l2jserver.game.net.Lineage2Client; @@ -112,8 +113,29 @@ public class NPCServiceImpl extends AbstractService implements NPCService { */ private Map, NPCController> controllers = CollectionFactory .newMap(); + /** + * List of all loaded NPCs + */ private Collection npcs; + /** + * @param spawnService + * the spawn service + * @param networkService + * the network service + * @param characterService + * the character service + * @param threadService + * the thread service + * @param attackService + * the attack service + * @param eventDispatcher + * the world service event dispatcher + * @param npcDao + * the npc DAO + * @param injector + * the {@link Guice} {@link Injector} + */ @Inject public NPCServiceImpl(SpawnService spawnService, NetworkService networkService, CharacterService characterService, @@ -213,9 +235,9 @@ public class NPCServiceImpl extends AbstractService implements NPCService { // TODO throw an exception return null; npc.setState(ActorState.MOVING); - + log.debug("{} is moving to {}", npc, point); - + // calculate walking time final Point3D start = npc.getPoint(); final double distance = start.getDistance(point); @@ -238,7 +260,7 @@ public class NPCServiceImpl extends AbstractService implements NPCService { Preconditions.checkNotNull(npc, "npc"); Preconditions.checkNotNull(conn, "conn"); Preconditions.checkNotNull(attacker, "attacker"); - + log.debug("{} is being attacked by {}", npc, attacker); final NPCTemplate template = npc.getTemplate(); @@ -249,6 +271,11 @@ public class NPCServiceImpl extends AbstractService implements NPCService { attackService.attack(attacker, npc); } + /** + * @param npc + * the {@link NPC} + * @return the {@link NPCController} for the given {@link NPC} + */ private NPCController getController(NPC npc) { // make sure everything's synchronized-no duplicated instances synchronized (controllers) { diff --git a/src/main/java/com/l2jserver/service/game/npc/NotAttackableNPCServiceException.java b/src/main/java/com/l2jserver/service/game/npc/NotAttackableNPCServiceException.java index 4f3db737e..52c370c66 100644 --- a/src/main/java/com/l2jserver/service/game/npc/NotAttackableNPCServiceException.java +++ b/src/main/java/com/l2jserver/service/game/npc/NotAttackableNPCServiceException.java @@ -24,5 +24,8 @@ import com.l2jserver.model.world.NPC; * @author Rogiel */ public class NotAttackableNPCServiceException extends NPCServiceException { + /** + * The Java Serialization API serial + */ private static final long serialVersionUID = 1L; } \ No newline at end of file diff --git a/src/main/java/com/l2jserver/service/game/scripting/ScriptingServiceImpl.java b/src/main/java/com/l2jserver/service/game/scripting/ScriptingServiceImpl.java index 8b709b752..07d6b39e6 100644 --- a/src/main/java/com/l2jserver/service/game/scripting/ScriptingServiceImpl.java +++ b/src/main/java/com/l2jserver/service/game/scripting/ScriptingServiceImpl.java @@ -29,6 +29,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; import com.google.common.base.Preconditions; +import com.google.inject.Guice; import com.google.inject.Inject; import com.google.inject.Injector; import com.l2jserver.service.AbstractService; @@ -56,6 +57,9 @@ public class ScriptingServiceImpl extends AbstractService implements private static final Logger log = LoggerFactory .getLogger(ScriptingServiceImpl.class); + /** + * The {@link Guice} {@link Injector} + */ private final Injector injector; /** @@ -63,6 +67,10 @@ public class ScriptingServiceImpl extends AbstractService implements */ private final Set contexts = CollectionFactory.newSet(); + /** + * @param injector + * the {@link Guice} {@link Injector} + */ @Inject public ScriptingServiceImpl(Injector injector) { this.injector = injector; diff --git a/src/main/java/com/l2jserver/service/game/scripting/classlistener/DefaultClassListener.java b/src/main/java/com/l2jserver/service/game/scripting/classlistener/DefaultClassListener.java index 6dd212d0e..4300030c8 100644 --- a/src/main/java/com/l2jserver/service/game/scripting/classlistener/DefaultClassListener.java +++ b/src/main/java/com/l2jserver/service/game/scripting/classlistener/DefaultClassListener.java @@ -18,6 +18,7 @@ package com.l2jserver.service.game.scripting.classlistener; import java.lang.reflect.Modifier; +import com.google.inject.Guice; import com.google.inject.Injector; import com.l2jserver.util.ClassUtils; @@ -25,8 +26,14 @@ import com.l2jserver.util.ClassUtils; * @author Rogiel */ public class DefaultClassListener implements ClassListener { + /** + * The {@link Guice} {@link Injector} + */ private final Injector injector; + /** + * @param injector the {@link Guice} {@link Injector} + */ public DefaultClassListener(Injector injector) { this.injector = injector; } diff --git a/src/main/java/com/l2jserver/service/game/scripting/classlistener/Loader.java b/src/main/java/com/l2jserver/service/game/scripting/classlistener/Loader.java index c270af15b..973418c61 100644 --- a/src/main/java/com/l2jserver/service/game/scripting/classlistener/Loader.java +++ b/src/main/java/com/l2jserver/service/game/scripting/classlistener/Loader.java @@ -16,6 +16,17 @@ */ package com.l2jserver.service.game.scripting.classlistener; +/** + * Interface that implements loading capability for a script + * + * @author Rogiel + */ public interface Loader { + /** + * Called once all scripts have been compiled and are available for use + * + * @param classes + * the script classes + */ void load(Class[] classes); } diff --git a/src/main/java/com/l2jserver/service/game/scripting/classlistener/Unloader.java b/src/main/java/com/l2jserver/service/game/scripting/classlistener/Unloader.java index b7eb9695e..6590d52ce 100644 --- a/src/main/java/com/l2jserver/service/game/scripting/classlistener/Unloader.java +++ b/src/main/java/com/l2jserver/service/game/scripting/classlistener/Unloader.java @@ -16,6 +16,17 @@ */ package com.l2jserver.service.game.scripting.classlistener; +/** + * Interface that implements unloading capability for a script + * + * @author Rogiel + */ public interface Unloader { + /** + * Called once all scripts are ready to be unloaded + * + * @param classes + * the script classes + */ void unload(Class[] classes); } diff --git a/src/main/java/com/l2jserver/service/game/scripting/impl/ScriptContextImpl.java b/src/main/java/com/l2jserver/service/game/scripting/impl/ScriptContextImpl.java index 98ac899e1..25c4140c5 100644 --- a/src/main/java/com/l2jserver/service/game/scripting/impl/ScriptContextImpl.java +++ b/src/main/java/com/l2jserver/service/game/scripting/impl/ScriptContextImpl.java @@ -24,6 +24,7 @@ import org.apache.commons.io.FileUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +import com.google.inject.Guice; import com.google.inject.Injector; import com.l2jserver.service.game.scripting.CompilationResult; import com.l2jserver.service.game.scripting.ScriptClassLoader; @@ -45,6 +46,9 @@ public class ScriptContextImpl implements ScriptContext { private static final Logger log = LoggerFactory .getLogger(ScriptContextImpl.class); + /** + * The {@link Guice} {@link Injector} + */ private final Injector injector; /** diff --git a/src/main/java/com/l2jserver/service/game/scripting/impl/compiled/PrecompiledScriptCompiler.java b/src/main/java/com/l2jserver/service/game/scripting/impl/compiled/PrecompiledScriptCompiler.java index a705058ed..617817ee2 100644 --- a/src/main/java/com/l2jserver/service/game/scripting/impl/compiled/PrecompiledScriptCompiler.java +++ b/src/main/java/com/l2jserver/service/game/scripting/impl/compiled/PrecompiledScriptCompiler.java @@ -36,6 +36,9 @@ public class PrecompiledScriptCompiler implements ScriptCompiler { */ protected ScriptClassLoader parentClassLoader; + /** + * Creates a new instance + */ public PrecompiledScriptCompiler() { } diff --git a/src/main/java/com/l2jserver/service/game/spawn/AlreadySpawnedServiceException.java b/src/main/java/com/l2jserver/service/game/spawn/AlreadySpawnedServiceException.java index 9a4ed6203..da0edcd5c 100644 --- a/src/main/java/com/l2jserver/service/game/spawn/AlreadySpawnedServiceException.java +++ b/src/main/java/com/l2jserver/service/game/spawn/AlreadySpawnedServiceException.java @@ -23,5 +23,8 @@ package com.l2jserver.service.game.spawn; * @author Rogiel */ public class AlreadySpawnedServiceException extends SpawnServiceException { + /** + * The Java Serialization API serial + */ private static final long serialVersionUID = 1L; } \ No newline at end of file diff --git a/src/main/java/com/l2jserver/service/game/spawn/CharacterAlreadyTeleportingServiceException.java b/src/main/java/com/l2jserver/service/game/spawn/CharacterAlreadyTeleportingServiceException.java index bd13f75c1..ee77e2b77 100644 --- a/src/main/java/com/l2jserver/service/game/spawn/CharacterAlreadyTeleportingServiceException.java +++ b/src/main/java/com/l2jserver/service/game/spawn/CharacterAlreadyTeleportingServiceException.java @@ -24,5 +24,8 @@ package com.l2jserver.service.game.spawn; */ public class CharacterAlreadyTeleportingServiceException extends SpawnServiceException { + /** + * The Java Serialization API serial + */ private static final long serialVersionUID = 1L; } \ No newline at end of file diff --git a/src/main/java/com/l2jserver/service/game/spawn/CharacterNotTeleportingServiceException.java b/src/main/java/com/l2jserver/service/game/spawn/CharacterNotTeleportingServiceException.java index 5dfb9c0a6..fb85900f6 100644 --- a/src/main/java/com/l2jserver/service/game/spawn/CharacterNotTeleportingServiceException.java +++ b/src/main/java/com/l2jserver/service/game/spawn/CharacterNotTeleportingServiceException.java @@ -24,5 +24,8 @@ package com.l2jserver.service.game.spawn; */ public class CharacterNotTeleportingServiceException extends SpawnServiceException { + /** + * The Java Serialization API serial + */ private static final long serialVersionUID = 1L; } \ No newline at end of file diff --git a/src/main/java/com/l2jserver/service/game/spawn/NotSpawnedServiceException.java b/src/main/java/com/l2jserver/service/game/spawn/NotSpawnedServiceException.java index c611cee5d..82edbd537 100644 --- a/src/main/java/com/l2jserver/service/game/spawn/NotSpawnedServiceException.java +++ b/src/main/java/com/l2jserver/service/game/spawn/NotSpawnedServiceException.java @@ -22,5 +22,8 @@ package com.l2jserver.service.game.spawn; * @author Rogiel */ public class NotSpawnedServiceException extends SpawnServiceException { + /** + * The Java Serialization API serial + */ private static final long serialVersionUID = 1L; } \ No newline at end of file diff --git a/src/main/java/com/l2jserver/service/game/spawn/SpawnPointNotFoundServiceException.java b/src/main/java/com/l2jserver/service/game/spawn/SpawnPointNotFoundServiceException.java index aff0934f8..1258ca0a7 100644 --- a/src/main/java/com/l2jserver/service/game/spawn/SpawnPointNotFoundServiceException.java +++ b/src/main/java/com/l2jserver/service/game/spawn/SpawnPointNotFoundServiceException.java @@ -22,5 +22,8 @@ package com.l2jserver.service.game.spawn; * @author Rogiel */ public class SpawnPointNotFoundServiceException extends SpawnServiceException { + /** + * The Java Serialization API serial + */ private static final long serialVersionUID = 1L; } \ No newline at end of file diff --git a/src/main/java/com/l2jserver/service/game/spawn/SpawnServiceException.java b/src/main/java/com/l2jserver/service/game/spawn/SpawnServiceException.java index 95139746a..50a703063 100644 --- a/src/main/java/com/l2jserver/service/game/spawn/SpawnServiceException.java +++ b/src/main/java/com/l2jserver/service/game/spawn/SpawnServiceException.java @@ -22,20 +22,46 @@ import com.l2jserver.service.ServiceException; * @author Rogiel */ public class SpawnServiceException extends ServiceException { + /** + * The Java Serialization API serial + */ private static final long serialVersionUID = 1L; + /** + * Creates a new instance of this exception + */ public SpawnServiceException() { super(); } + /** + * Creates a new instance of this exception + * + * @param message + * the message + * @param cause + * the root cause + */ public SpawnServiceException(String message, Throwable cause) { super(message, cause); } + /** + * Creates a new instance of this exception + * + * @param message + * the message + */ public SpawnServiceException(String message) { super(message); } + /** + * Creates a new instance of this exception + * + * @param cause + * the root cause + */ public SpawnServiceException(Throwable cause) { super(cause); } diff --git a/src/main/java/com/l2jserver/service/game/spawn/SpawnServiceImpl.java b/src/main/java/com/l2jserver/service/game/spawn/SpawnServiceImpl.java index 9fd2e5619..0bcca1710 100644 --- a/src/main/java/com/l2jserver/service/game/spawn/SpawnServiceImpl.java +++ b/src/main/java/com/l2jserver/service/game/spawn/SpawnServiceImpl.java @@ -80,6 +80,16 @@ public class SpawnServiceImpl extends AbstractService implements SpawnService { */ private final ThreadService threadService; + /** + * @param worldService + * the world service + * @param eventDispatcher + * the world service event dispatcher + * @param networkService + * the network service + * @param threadService + * the thread service + */ @Inject public SpawnServiceImpl(WorldService worldService, WorldEventDispatcher eventDispatcher, @@ -213,10 +223,9 @@ public class SpawnServiceImpl extends AbstractService implements SpawnService { throws CharacterAlreadyTeleportingServiceException { Preconditions.checkNotNull(player, "player"); Preconditions.checkNotNull(coordinate, "coordinate"); - - log.debug("Teleporting {} to {}", player, - coordinate); - + + log.debug("Teleporting {} to {}", player, coordinate); + if (player instanceof L2Character) { if (((L2Character) player).isTeleporting()) throw new CharacterAlreadyTeleportingServiceException(); @@ -248,7 +257,7 @@ public class SpawnServiceImpl extends AbstractService implements SpawnService { if (!character.isTeleporting()) throw new CharacterNotTeleportingServiceException(); - + log.debug("Finishing teleport of {}", character); character.setState(null); diff --git a/src/main/java/com/l2jserver/service/game/template/TemplateService.java b/src/main/java/com/l2jserver/service/game/template/TemplateService.java index 90e865720..2a4242403 100644 --- a/src/main/java/com/l2jserver/service/game/template/TemplateService.java +++ b/src/main/java/com/l2jserver/service/game/template/TemplateService.java @@ -37,6 +37,11 @@ import com.l2jserver.service.ServiceConfiguration; * @author Rogiel */ public interface TemplateService extends Service { + /** + * The template service configuration interface + * + * @author Rogiel + */ public interface TemplateServiceConfiguration extends ServiceConfiguration { } diff --git a/src/main/java/com/l2jserver/service/game/template/XMLTemplateService.java b/src/main/java/com/l2jserver/service/game/template/XMLTemplateService.java index eeca18805..f8d1f0ae6 100644 --- a/src/main/java/com/l2jserver/service/game/template/XMLTemplateService.java +++ b/src/main/java/com/l2jserver/service/game/template/XMLTemplateService.java @@ -26,6 +26,7 @@ import java.nio.file.SimpleFileVisitor; import java.nio.file.attribute.BasicFileAttributes; import java.util.List; +import javax.xml.bind.JAXB; import javax.xml.bind.JAXBContext; import javax.xml.bind.JAXBException; import javax.xml.bind.Unmarshaller; @@ -63,38 +64,110 @@ import com.l2jserver.util.jaxb.NPCTemplateIDAdapter; import com.l2jserver.util.jaxb.SkillTemplateIDAdapter; import com.l2jserver.util.jaxb.TeleportationTemplateIDAdapter; +/** + * This service loads template data from XML files using the {@link JAXB} + * service. + * + * @author Rogiel + */ @Depends({ LoggingService.class, VFSService.class, CacheService.class, ConfigurationService.class }) public class XMLTemplateService extends AbstractService implements TemplateService { + /** + * The logger + */ private final Logger log = LoggerFactory.getLogger(this.getClass()); + /** + * The vfs service + */ private final VFSService vfsService; + /** + * The cache service + */ private final CacheService cacheService; + /** + * The XML template service configuration + */ private final XMLTemplateServiceConfiguration config; + /** + * The npc template id adapter + */ private final NPCTemplateIDAdapter npcTemplateIdAdapter; + /** + * The item template id adapter + */ private final ItemTemplateIDAdapter itemTemplateIdAdapter; + /** + * The skill template id adapter + */ private final SkillTemplateIDAdapter skillTemplateIdAdapter; + /** + * The character template id adapter + */ private final CharacterTemplateIDAdapter charIdTemplateAdapter; + /** + * The teleportation template id adapater + */ private final TeleportationTemplateIDAdapter teleportationIdTemplateAdapter; + /** + * The {@link JAXB} context + */ private JAXBContext context; + /** + * The {@link JAXB} unmarshaller + */ private Unmarshaller unmarshaller; + /** + * An cache of all loaded templates + */ @SuppressWarnings("rawtypes") private Cache templates; + /** + * XML {@link TemplateService} configuration interface + * + * @author Rogiel + */ @ConfigurationName("template") public interface XMLTemplateServiceConfiguration extends TemplateServiceConfiguration { + /** + * @return the directory in which templates are stored + */ @ConfigurationPropertyGetter(name = "template.directory", defaultValue = "data/templates") URI getTemplateDirectory(); + /** + * @param file + * the directory in which templates are stored + */ @ConfigurationPropertySetter(name = "template.directory") void setTemplateDirectory(URI file); } + /** + * @param vfsService + * the vfs service + * @param cacheService + * the cache service + * @param configService + * the configuration service + * @param npcTemplateIdAdapter + * the npc template id adapter + * @param itemTemplateIdAdapter + * the item template id adapter + * @param skillTemplateIdAdapter + * the skill template id adapter + * @param charIdTemplateAdapter + * the character id template adapter + * @param teleportationIdTemplateAdapter + * the teleportation template id adapter + */ @Inject public XMLTemplateService(final VFSService vfsService, CacheService cacheService, ConfigurationService configService, @@ -188,6 +261,16 @@ public class XMLTemplateService extends AbstractService implements return (T) templates.get(id); } + /** + * Loads the template located in path + * + * @param path + * the path to the template + * @throws JAXBException + * if any error occur while processing the XML + * @throws IOException + * if any error occur in the I/O level + */ public void loadTemplate(Path path) throws JAXBException, IOException { Preconditions.checkNotNull(path, "path"); log.debug("Loading template {}", path); @@ -203,6 +286,12 @@ public class XMLTemplateService extends AbstractService implements } } + /** + * Removes the given template from the cache + * + * @param template + * the template to be purged + */ public void removeTemplate(Template template) { Preconditions.checkNotNull(template, "template"); log.debug("Removing template {}", template); @@ -217,10 +306,18 @@ public class XMLTemplateService extends AbstractService implements context = null; } + /** + * The teleportation template container + * + * @author Rogiel + */ @XmlRootElement(name = "teleports") @XmlAccessorType(XmlAccessType.FIELD) @XmlType(namespace = "teleports") public static class TeleportationTemplateContainer { + /** + * The list of all teleportation templates + */ @XmlElement(name = "teleport") public List templates; } diff --git a/src/main/java/com/l2jserver/service/game/world/CachedWorldIDService.java b/src/main/java/com/l2jserver/service/game/world/CachedWorldIDService.java index b2eb4398d..42f95fe90 100644 --- a/src/main/java/com/l2jserver/service/game/world/CachedWorldIDService.java +++ b/src/main/java/com/l2jserver/service/game/world/CachedWorldIDService.java @@ -84,6 +84,13 @@ public class CachedWorldIDService extends AbstractService implements */ private boolean loaded = false; + /** + * @param cacheService the cache service + * @param allocator the id allocator + * @param characterDao the character DAO + * @param itemDao the item dao + * @param npcDao the NPC dao + */ @Inject public CachedWorldIDService(CacheService cacheService, IDAllocator allocator, CharacterDAO characterDao, ItemDAO itemDao, diff --git a/src/main/java/com/l2jserver/service/game/world/WorldServiceImpl.java b/src/main/java/com/l2jserver/service/game/world/WorldServiceImpl.java index 8c1353aac..f33465714 100644 --- a/src/main/java/com/l2jserver/service/game/world/WorldServiceImpl.java +++ b/src/main/java/com/l2jserver/service/game/world/WorldServiceImpl.java @@ -72,6 +72,12 @@ public class WorldServiceImpl extends AbstractService implements WorldService { */ private final WorldIDService idService; + /** + * @param dispatcher + * the world service event dispatcher + * @param idService + * the world id service + */ @Inject public WorldServiceImpl(WorldEventDispatcher dispatcher, WorldIDService idService) { diff --git a/src/main/java/com/l2jserver/service/game/world/event/FilteredWorldListener.java b/src/main/java/com/l2jserver/service/game/world/event/FilteredWorldListener.java index 2ae7b6423..4e7d45c48 100644 --- a/src/main/java/com/l2jserver/service/game/world/event/FilteredWorldListener.java +++ b/src/main/java/com/l2jserver/service/game/world/event/FilteredWorldListener.java @@ -30,8 +30,15 @@ import com.l2jserver.service.game.world.filter.WorldObjectFilter; */ public abstract class FilteredWorldListener implements WorldListener { + /** + * The filter that will be used to filter incoming events + */ private final WorldObjectFilter filter; + /** + * @param filter + * the filter used to filter events + */ public FilteredWorldListener(WorldObjectFilter filter) { Preconditions.checkNotNull(filter, "filter"); this.filter = filter; diff --git a/src/main/java/com/l2jserver/service/game/world/event/TypedWorldListener.java b/src/main/java/com/l2jserver/service/game/world/event/TypedWorldListener.java index 6cd212845..6a9b8d2e8 100644 --- a/src/main/java/com/l2jserver/service/game/world/event/TypedWorldListener.java +++ b/src/main/java/com/l2jserver/service/game/world/event/TypedWorldListener.java @@ -27,8 +27,15 @@ import com.google.common.base.Preconditions; * @author Rogiel */ public abstract class TypedWorldListener implements WorldListener { + /** + * The type this listener will accept + */ private final Class type; + /** + * @param type + * the type of accepted events + */ public TypedWorldListener(Class type) { Preconditions.checkNotNull(type, "type"); this.type = type; diff --git a/src/main/java/com/l2jserver/service/game/world/event/WorldEvent.java b/src/main/java/com/l2jserver/service/game/world/event/WorldEvent.java index 1b76d253e..ddc9bf38e 100644 --- a/src/main/java/com/l2jserver/service/game/world/event/WorldEvent.java +++ b/src/main/java/com/l2jserver/service/game/world/event/WorldEvent.java @@ -19,6 +19,12 @@ package com.l2jserver.service.game.world.event; import com.l2jserver.model.id.ObjectID; import com.l2jserver.model.world.WorldObject; +/** + * Base event class. Every event must implement this interface in order to be + * dispatched by {@link WorldEventDispatcher} + * + * @author Rogiel + */ public interface WorldEvent { /** * @return the object that issued this event diff --git a/src/main/java/com/l2jserver/service/game/world/event/WorldEventDispatcherImpl.java b/src/main/java/com/l2jserver/service/game/world/event/WorldEventDispatcherImpl.java index e692d5e2a..8e9af6d3d 100644 --- a/src/main/java/com/l2jserver/service/game/world/event/WorldEventDispatcherImpl.java +++ b/src/main/java/com/l2jserver/service/game/world/event/WorldEventDispatcherImpl.java @@ -48,6 +48,9 @@ public class WorldEventDispatcherImpl implements WorldEventDispatcher { private static final Logger log = LoggerFactory .getLogger(WorldEventDispatcherImpl.class); + /** + * The thread service + */ private final ThreadService threadService; /** @@ -70,11 +73,18 @@ public class WorldEventDispatcherImpl implements WorldEventDispatcher { private Queue events = CollectionFactory .newConcurrentQueue(); + /** + * @param threadService + * the thread service + */ @Inject public WorldEventDispatcherImpl(ThreadService threadService) { this.threadService = threadService; } + /** + * Stats the world event disptacher + */ public void start() { threadPool = threadService.createThreadPool("event-dispatcher", 1); threadPool.async(0, TimeUnit.MILLISECONDS, 20, new TimerTask() { @@ -229,6 +239,9 @@ public class WorldEventDispatcherImpl implements WorldEventDispatcher { return set; } + /** + * Stops the world event dispatcher + */ public void stop() { threadService.dispose(threadPool); threadPool = null; @@ -243,7 +256,13 @@ public class WorldEventDispatcherImpl implements WorldEventDispatcher { */ private static class WorldEventFutureImpl extends AbstractFuture implements WorldEventFuture { + /** + * The running state of the dispatching event + */ private boolean running = false; + /** + * Will be true if the event has been dispatched to all listeners + */ private boolean complete = false; @Override diff --git a/src/main/java/com/l2jserver/service/game/world/filter/impl/CharacterBroadcastFilter.java b/src/main/java/com/l2jserver/service/game/world/filter/impl/CharacterBroadcastFilter.java index 0b21c85a6..1f94b1b77 100644 --- a/src/main/java/com/l2jserver/service/game/world/filter/impl/CharacterBroadcastFilter.java +++ b/src/main/java/com/l2jserver/service/game/world/filter/impl/CharacterBroadcastFilter.java @@ -24,6 +24,10 @@ import com.l2jserver.service.game.world.filter.WorldObjectFilter; * @author Rogiel */ public class CharacterBroadcastFilter extends AndFilter { + /** + * @param character + * the character to filter + */ @SuppressWarnings({ "unchecked", "rawtypes" }) public CharacterBroadcastFilter(L2Character character) { super(new InstanceFilter(L2Character.class), diff --git a/src/main/java/com/l2jserver/service/game/world/filter/impl/KnownListFilter.java b/src/main/java/com/l2jserver/service/game/world/filter/impl/KnownListFilter.java index 4c9440ae0..205e16703 100644 --- a/src/main/java/com/l2jserver/service/game/world/filter/impl/KnownListFilter.java +++ b/src/main/java/com/l2jserver/service/game/world/filter/impl/KnownListFilter.java @@ -28,8 +28,14 @@ import com.l2jserver.service.game.world.filter.ExcludeFilter; * @author Rogiel */ public class KnownListFilter extends AndFilter { + /** + * Constant declaring the range in which knownlist will be scanned + */ public static final int KNOWNLIST_RANGE = 2000; + /** + * @param object the object to locate known objects + */ @SuppressWarnings("unchecked") public KnownListFilter(PositionableObject object) { super(new InstanceFilter(PositionableObject.class), diff --git a/src/main/java/com/l2jserver/service/game/world/filter/impl/KnownListUpdateFilter.java b/src/main/java/com/l2jserver/service/game/world/filter/impl/KnownListUpdateFilter.java index 248de5038..ade8f61d2 100644 --- a/src/main/java/com/l2jserver/service/game/world/filter/impl/KnownListUpdateFilter.java +++ b/src/main/java/com/l2jserver/service/game/world/filter/impl/KnownListUpdateFilter.java @@ -23,14 +23,29 @@ import com.l2jserver.service.game.world.filter.NotFilter; import com.l2jserver.util.geometry.Point3D; /** - * This filter will only accept {@link WorldObject} which are in vision of - * another object. + * This filter will only accept {@link WorldObject} which were not in vision of + * object when it was positioned at old and are visible now. * * @author Rogiel */ public class KnownListUpdateFilter extends AndFilter { + /** + * Constant declaring the range in which knownlist will be scanned + */ public static final int KNOWNLIST_RANGE = 2000; + /** + * Creates a new instance. + *

+ * This filter will only accept {@link WorldObject} which were not in vision + * of object when it was positioned at old and are visible + * now. + * + * @param object + * the object in the center of the range + * @param old + * the old position + */ @SuppressWarnings("unchecked") public KnownListUpdateFilter(PositionableObject object, Point3D old) { super(new KnownListFilter(object), new NotFilter( diff --git a/src/main/java/com/l2jserver/service/network/NettyNetworkService.java b/src/main/java/com/l2jserver/service/network/NettyNetworkService.java index 79a2a7d7a..928b1ec58 100644 --- a/src/main/java/com/l2jserver/service/network/NettyNetworkService.java +++ b/src/main/java/com/l2jserver/service/network/NettyNetworkService.java @@ -30,6 +30,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; import com.google.common.base.Preconditions; +import com.google.inject.Guice; import com.google.inject.Inject; import com.google.inject.Injector; import com.l2jserver.game.net.Lineage2Client; @@ -85,6 +86,11 @@ public class NettyNetworkService extends AbstractService implements */ private Set clients = CollectionFactory.newSet(); + /** + * @param configService the configuration service + * @param injector the {@link Guice} {@link Injector} + * @param worldService the world service + */ @Inject public NettyNetworkService(ConfigurationService configService, Injector injector, WorldService worldService) { diff --git a/src/main/java/com/l2jserver/service/network/broadcast/BroadcastServiceImpl.java b/src/main/java/com/l2jserver/service/network/broadcast/BroadcastServiceImpl.java index b464abd97..d03825dd8 100644 --- a/src/main/java/com/l2jserver/service/network/broadcast/BroadcastServiceImpl.java +++ b/src/main/java/com/l2jserver/service/network/broadcast/BroadcastServiceImpl.java @@ -69,9 +69,19 @@ public class BroadcastServiceImpl extends AbstractService implements */ private final Logger log = LoggerFactory.getLogger(this.getClass()); + /** + * The world service + */ private final WorldService worldService; + /** + * The world service event dispatcher + */ private final WorldEventDispatcher eventDispatcher; + /** + * @param worldService the world service + * @param eventDispatcher the world service event disptacher + */ @Inject public BroadcastServiceImpl(WorldService worldService, WorldEventDispatcher eventDispatcher) { diff --git a/src/main/java/com/l2jserver/service/network/gameguard/GameGuardServiceImpl.java b/src/main/java/com/l2jserver/service/network/gameguard/GameGuardServiceImpl.java index e31961edd..541e6222b 100644 --- a/src/main/java/com/l2jserver/service/network/gameguard/GameGuardServiceImpl.java +++ b/src/main/java/com/l2jserver/service/network/gameguard/GameGuardServiceImpl.java @@ -48,7 +48,7 @@ public class GameGuardServiceImpl extends AbstractService implements * The logger */ private final Logger log = LoggerFactory.getLogger(this.getClass()); - + /** * The static key used to validate game guards */ @@ -107,7 +107,7 @@ public class GameGuardServiceImpl extends AbstractService implements @Override public GameGuardResponse key(Lineage2Client conn, byte[] key) { log.debug("GameGuard authentication key received for {}", conn); - + final GGFuture future = futures.remove(conn); final boolean validated = validate(conn, key); final GameGuardResponse response = (validated ? GameGuardResponse.VALID @@ -139,6 +139,12 @@ public class GameGuardServiceImpl extends AbstractService implements digester = null; } + /** + * The GGFuture awaits for the + * {@link com.l2jserver.service.network.gameguard.GameGuardService.GameGuardResponse} + * + * @author Rogiel + */ private class GGFuture extends AbstractFuture implements Future { @Override diff --git a/src/main/java/com/l2jserver/util/RGBColor.java b/src/main/java/com/l2jserver/util/RGBColor.java index ecce26ae8..790639f9e 100644 --- a/src/main/java/com/l2jserver/util/RGBColor.java +++ b/src/main/java/com/l2jserver/util/RGBColor.java @@ -35,6 +35,12 @@ public class RGBColor { */ private final byte blue; + /** + * Creates a new RGB (red-green-blue) color + * @param r the red byte + * @param g the green byte + * @param b the blue byte + */ protected RGBColor(byte r, byte g, byte b) { this.red = r; this.green = g; @@ -80,10 +86,19 @@ public class RGBColor { return (red >> 24) + (green >> 16) + (blue >> 8); } + /** + * Creates an {@link RGBColor} from an byte array + * @param rgb the RGB byte array + * @return the {@link RGBColor} + */ public static RGBColor fromByteArray(byte[] rgb) { return new RGBColor(rgb[0], rgb[1], rgb[2]); } + /** + * @param color the color integer + * @return the {@link RGBColor} + */ public static RGBColor fromInteger(int color) { return new RGBColor((byte) (color << 0), (byte) (color << 8), (byte) (color << 16)); diff --git a/src/main/java/com/l2jserver/util/geometry/Coordinate.java b/src/main/java/com/l2jserver/util/geometry/Coordinate.java index 0e106b146..4449b71a9 100644 --- a/src/main/java/com/l2jserver/util/geometry/Coordinate.java +++ b/src/main/java/com/l2jserver/util/geometry/Coordinate.java @@ -45,14 +45,23 @@ public class Coordinate { this.vector = new Vector3D(x, y, z); } + /** + * @return the x cord + */ public int getX() { return (int) vector.getX(); } + /** + * @return the y cord + */ public int getY() { return (int) vector.getY(); } + /** + * @return the z cord + */ public int getZ() { return (int) vector.getZ(); } @@ -102,6 +111,9 @@ public class Coordinate { return "Coordinate [" + vector + "]"; } + /** + * @return the {@link Point3D} representing this {@link Coordinate} + */ public Point3D toPoint() { return new Point3D(this, 0); } diff --git a/src/main/java/com/l2jserver/util/html/L2BodyTag.java b/src/main/java/com/l2jserver/util/html/L2BodyTag.java index 1956fa5bd..bc6579891 100644 --- a/src/main/java/com/l2jserver/util/html/L2BodyTag.java +++ b/src/main/java/com/l2jserver/util/html/L2BodyTag.java @@ -27,8 +27,14 @@ import org.htmlparser.util.NodeList; * @author Rogiel */ public class L2BodyTag extends BodyTag { + /** + * The Java Serialization API Serial + */ private static final long serialVersionUID = 1L; + /** + * Creates a new instance of this tag + */ public L2BodyTag() { super.setTagName("body"); Tag end = new TagNode(); diff --git a/src/main/java/com/l2jserver/util/html/L2BrTag.java b/src/main/java/com/l2jserver/util/html/L2BrTag.java index fa0514743..4080a9a50 100644 --- a/src/main/java/com/l2jserver/util/html/L2BrTag.java +++ b/src/main/java/com/l2jserver/util/html/L2BrTag.java @@ -25,8 +25,14 @@ import org.htmlparser.tags.Span; * @author Rogiel */ public class L2BrTag extends Span { + /** + * The Java Serialization API Serial + */ private static final long serialVersionUID = 1L; + /** + * Creates a new instance of this tag + */ public L2BrTag() { super.setTagName("br"); } diff --git a/src/main/java/com/l2jserver/util/html/L2CenterTag.java b/src/main/java/com/l2jserver/util/html/L2CenterTag.java index 84d129241..02425ad9a 100644 --- a/src/main/java/com/l2jserver/util/html/L2CenterTag.java +++ b/src/main/java/com/l2jserver/util/html/L2CenterTag.java @@ -26,8 +26,14 @@ import org.htmlparser.tags.Span; * @author Rogiel */ public class L2CenterTag extends Span { + /** + * The Java Serialization API Serial + */ private static final long serialVersionUID = 1L; + /** + * Creates a new instance of this tag + */ public L2CenterTag() { super.setTagName("center"); Tag end = new TagNode(); diff --git a/src/main/java/com/l2jserver/util/html/L2DivTag.java b/src/main/java/com/l2jserver/util/html/L2DivTag.java index d7d25987f..a9c4e10ac 100644 --- a/src/main/java/com/l2jserver/util/html/L2DivTag.java +++ b/src/main/java/com/l2jserver/util/html/L2DivTag.java @@ -27,8 +27,14 @@ import org.htmlparser.util.NodeList; * @author Rogiel */ public class L2DivTag extends Div { + /** + * The Java Serialization API Serial + */ private static final long serialVersionUID = 1L; + /** + * Creates a new instance of this tag + */ public L2DivTag() { super.setTagName("div"); Tag end = new TagNode(); diff --git a/src/main/java/com/l2jserver/util/html/L2FontTag.java b/src/main/java/com/l2jserver/util/html/L2FontTag.java index de8789aff..9351f6580 100644 --- a/src/main/java/com/l2jserver/util/html/L2FontTag.java +++ b/src/main/java/com/l2jserver/util/html/L2FontTag.java @@ -27,8 +27,14 @@ import org.htmlparser.util.NodeList; * @author Rogiel */ public class L2FontTag extends Span { + /** + * The Java Serialization API Serial + */ private static final long serialVersionUID = 1L; + /** + * Creates a new instance of this tag + */ public L2FontTag() { super.setTagName("font"); Tag end = new TagNode(); diff --git a/src/main/java/com/l2jserver/util/html/L2HeadTag.java b/src/main/java/com/l2jserver/util/html/L2HeadTag.java index e5a24bddf..1be4d1ae6 100644 --- a/src/main/java/com/l2jserver/util/html/L2HeadTag.java +++ b/src/main/java/com/l2jserver/util/html/L2HeadTag.java @@ -27,8 +27,14 @@ import org.htmlparser.util.NodeList; * @author Rogiel */ public class L2HeadTag extends HeadTag { + /** + * The Java Serialization API Serial + */ private static final long serialVersionUID = 1L; + /** + * Creates a new instance of this tag + */ public L2HeadTag() { super.setTagName("head"); Tag end = new TagNode(); diff --git a/src/main/java/com/l2jserver/util/html/L2HtmlTag.java b/src/main/java/com/l2jserver/util/html/L2HtmlTag.java index 9704abc57..04228ff8b 100644 --- a/src/main/java/com/l2jserver/util/html/L2HtmlTag.java +++ b/src/main/java/com/l2jserver/util/html/L2HtmlTag.java @@ -27,8 +27,14 @@ import org.htmlparser.util.NodeList; * @author Rogiel */ public class L2HtmlTag extends Html { + /** + * The Java Serialization API Serial + */ private static final long serialVersionUID = 1L; + /** + * Creates a new instance of this tag + */ public L2HtmlTag() { super.setTagName("html"); Tag end = new TagNode(); diff --git a/src/main/java/com/l2jserver/util/html/L2ImageTag.java b/src/main/java/com/l2jserver/util/html/L2ImageTag.java index 1764c37b2..57a598521 100644 --- a/src/main/java/com/l2jserver/util/html/L2ImageTag.java +++ b/src/main/java/com/l2jserver/util/html/L2ImageTag.java @@ -26,8 +26,14 @@ import org.htmlparser.tags.ImageTag; * @author Rogiel */ public class L2ImageTag extends ImageTag { + /** + * The Java Serialization API Serial + */ private static final long serialVersionUID = 1L; + /** + * Creates a new instance of this tag + */ public L2ImageTag() { super.setTagName("img"); Tag end = new TagNode(); diff --git a/src/main/java/com/l2jserver/util/html/L2LinkTag.java b/src/main/java/com/l2jserver/util/html/L2LinkTag.java index f243166a6..d3b93ce37 100644 --- a/src/main/java/com/l2jserver/util/html/L2LinkTag.java +++ b/src/main/java/com/l2jserver/util/html/L2LinkTag.java @@ -27,8 +27,14 @@ import org.htmlparser.util.NodeList; * @author Rogiel */ public class L2LinkTag extends LinkTag { + /** + * The Java Serialization API Serial + */ private static final long serialVersionUID = 1L; + /** + * Creates a new instance of this tag + */ public L2LinkTag() { super.setTagName("a"); Tag end = new TagNode(); diff --git a/src/main/java/com/l2jserver/util/html/L2NewLineTag.java b/src/main/java/com/l2jserver/util/html/L2NewLineTag.java index d008323bd..eb744a51a 100644 --- a/src/main/java/com/l2jserver/util/html/L2NewLineTag.java +++ b/src/main/java/com/l2jserver/util/html/L2NewLineTag.java @@ -25,8 +25,14 @@ import org.htmlparser.tags.Span; * @author Rogiel */ public class L2NewLineTag extends Span { + /** + * The Java Serialization API Serial + */ private static final long serialVersionUID = 1L; + /** + * Creates a new instance of this tag + */ public L2NewLineTag() { super.setTagName("p"); } diff --git a/src/main/java/com/l2jserver/util/html/L2TitleTag.java b/src/main/java/com/l2jserver/util/html/L2TitleTag.java index 6b34189e2..b14965cf4 100644 --- a/src/main/java/com/l2jserver/util/html/L2TitleTag.java +++ b/src/main/java/com/l2jserver/util/html/L2TitleTag.java @@ -27,8 +27,14 @@ import org.htmlparser.util.NodeList; * @author Rogiel */ public class L2TitleTag extends TitleTag { + /** + * The Java Serialization API Serial + */ private static final long serialVersionUID = 1L; + /** + * Creates a new instance of this tag + */ public L2TitleTag() { super.setTagName("title"); Tag end = new TagNode(); diff --git a/src/main/java/com/l2jserver/util/jaxb/CharacterTemplateIDAdapter.java b/src/main/java/com/l2jserver/util/jaxb/CharacterTemplateIDAdapter.java index 0a878e878..471745a2a 100644 --- a/src/main/java/com/l2jserver/util/jaxb/CharacterTemplateIDAdapter.java +++ b/src/main/java/com/l2jserver/util/jaxb/CharacterTemplateIDAdapter.java @@ -30,8 +30,15 @@ import com.l2jserver.model.template.character.CharacterClass; */ public class CharacterTemplateIDAdapter extends XmlAdapter { + /** + * The character template id provider + */ private final CharacterTemplateIDProvider provider; + /** + * @param provider + * the character template id provider + */ @Inject public CharacterTemplateIDAdapter(CharacterTemplateIDProvider provider) { this.provider = provider; diff --git a/src/main/java/com/l2jserver/util/jaxb/CoordinateAdapter.java b/src/main/java/com/l2jserver/util/jaxb/CoordinateAdapter.java index f2c8b4b77..074249162 100644 --- a/src/main/java/com/l2jserver/util/jaxb/CoordinateAdapter.java +++ b/src/main/java/com/l2jserver/util/jaxb/CoordinateAdapter.java @@ -47,17 +47,38 @@ public class CoordinateAdapter extends } - public static class CoordinateElement { + /** + * Internal usage class: class used to read coordinate data from XML file + * @author Rogiel + */ + protected static class CoordinateElement { + /** + * The x cord + */ @XmlAttribute(name = "x") public int x; + /** + * The y cord + */ @XmlAttribute(name = "y") public int y; + /** + * The z cord + */ @XmlAttribute(name = "z") public int z; + /** + * Creates a new empty instance. Created only from JAXB + */ protected CoordinateElement() { } + /** + * @param x the x cord + * @param y the y cord + * @param z the z cord + */ public CoordinateElement(int x, int y, int z) { super(); this.x = x; diff --git a/src/main/java/com/l2jserver/util/jaxb/ItemTemplateIDAdapter.java b/src/main/java/com/l2jserver/util/jaxb/ItemTemplateIDAdapter.java index a6bf7d3cf..2cca0deb4 100644 --- a/src/main/java/com/l2jserver/util/jaxb/ItemTemplateIDAdapter.java +++ b/src/main/java/com/l2jserver/util/jaxb/ItemTemplateIDAdapter.java @@ -28,12 +28,21 @@ import com.l2jserver.model.id.template.provider.ItemTemplateIDProvider; * @author Rogiel */ public class ItemTemplateIDAdapter extends XmlAdapter { + /** + * The item template id provider + */ private final ItemTemplateIDProvider provider; + /** + * Creates a new empty instance + */ public ItemTemplateIDAdapter() { provider = null; } + /** + * @param provider the item template id provider + */ @Inject public ItemTemplateIDAdapter(ItemTemplateIDProvider provider) { this.provider = provider; diff --git a/src/main/java/com/l2jserver/util/jaxb/MapAdapter.java b/src/main/java/com/l2jserver/util/jaxb/MapAdapter.java index 90784a7a1..c471f6527 100644 --- a/src/main/java/com/l2jserver/util/jaxb/MapAdapter.java +++ b/src/main/java/com/l2jserver/util/jaxb/MapAdapter.java @@ -44,15 +44,35 @@ public class MapAdapter extends XmlAdapter> { } + /** + * Internal usage class: reads map data from XML file + * + * @author Rogiel + */ public static class MapElements { + /** + * The key attribute + */ @XmlAttribute(name = "id") public String key; + /** + * The tag value + */ @XmlValue public String value; + /** + * Creates an empty instance. Invoked from JAXB. + */ protected MapElements() { } + /** + * @param key + * the key attribute + * @param value + * the tag value + */ public MapElements(String key, String value) { this.key = key; this.value = value; diff --git a/src/main/java/com/l2jserver/util/jaxb/NPCTemplateIDAdapter.java b/src/main/java/com/l2jserver/util/jaxb/NPCTemplateIDAdapter.java index 23549ae3b..6425e9f10 100644 --- a/src/main/java/com/l2jserver/util/jaxb/NPCTemplateIDAdapter.java +++ b/src/main/java/com/l2jserver/util/jaxb/NPCTemplateIDAdapter.java @@ -21,6 +21,7 @@ import javax.xml.bind.annotation.adapters.XmlAdapter; import com.google.inject.Inject; import com.l2jserver.model.id.template.NPCTemplateID; import com.l2jserver.model.id.template.provider.NPCTemplateIDProvider; +import com.l2jserver.model.world.NPC; /** * This class is an JAXB Adapter for {@link NPCTemplateIDProvider} @@ -28,12 +29,21 @@ import com.l2jserver.model.id.template.provider.NPCTemplateIDProvider; * @author Rogiel */ public class NPCTemplateIDAdapter extends XmlAdapter { + /** + * The {@link NPC} template id provider + */ private final NPCTemplateIDProvider provider; + /** + * Creates a new empty instance + */ public NPCTemplateIDAdapter() { provider = null; } + /** + * @param provider the {@link NPC} template id provider + */ @Inject public NPCTemplateIDAdapter(NPCTemplateIDProvider provider) { this.provider = provider; diff --git a/src/main/java/com/l2jserver/util/jaxb/SkillTemplateIDAdapter.java b/src/main/java/com/l2jserver/util/jaxb/SkillTemplateIDAdapter.java index fc0b7e386..a9e821e5a 100644 --- a/src/main/java/com/l2jserver/util/jaxb/SkillTemplateIDAdapter.java +++ b/src/main/java/com/l2jserver/util/jaxb/SkillTemplateIDAdapter.java @@ -19,6 +19,7 @@ package com.l2jserver.util.jaxb; import javax.xml.bind.annotation.adapters.XmlAdapter; import com.google.inject.Inject; +import com.l2jserver.model.game.Skill; import com.l2jserver.model.id.template.SkillTemplateID; import com.l2jserver.model.id.template.provider.SkillTemplateIDProvider; @@ -29,12 +30,21 @@ import com.l2jserver.model.id.template.provider.SkillTemplateIDProvider; */ public class SkillTemplateIDAdapter extends XmlAdapter { + /** + * The {@link Skill} template id provider + */ private final SkillTemplateIDProvider provider; + /** + * Creates a new empty instance + */ public SkillTemplateIDAdapter() { provider = null; } + /** + * @param provider the {@link Skill} template id provider + */ @Inject public SkillTemplateIDAdapter(SkillTemplateIDProvider provider) { this.provider = provider; diff --git a/src/main/java/com/l2jserver/util/jaxb/TeleportationTemplateIDAdapter.java b/src/main/java/com/l2jserver/util/jaxb/TeleportationTemplateIDAdapter.java index e67cc4e1e..ec5b890c1 100644 --- a/src/main/java/com/l2jserver/util/jaxb/TeleportationTemplateIDAdapter.java +++ b/src/main/java/com/l2jserver/util/jaxb/TeleportationTemplateIDAdapter.java @@ -29,12 +29,21 @@ import com.l2jserver.model.id.template.provider.TeleportationTemplateIDProvider; */ public class TeleportationTemplateIDAdapter extends XmlAdapter { + /** + * The teleportation template id provider + */ private final TeleportationTemplateIDProvider provider; + /** + * Creates a new empty instance + */ public TeleportationTemplateIDAdapter() { provider = null; } + /** + * @param provider the teleportation template id provider + */ @Inject public TeleportationTemplateIDAdapter( TeleportationTemplateIDProvider provider) { diff --git a/src/main/java/com/l2jserver/util/transformer/impl/BooleanTransformer.java b/src/main/java/com/l2jserver/util/transformer/impl/BooleanTransformer.java index 73712317e..f7db5c74b 100644 --- a/src/main/java/com/l2jserver/util/transformer/impl/BooleanTransformer.java +++ b/src/main/java/com/l2jserver/util/transformer/impl/BooleanTransformer.java @@ -24,6 +24,9 @@ import com.l2jserver.util.transformer.Transformer; * @author Rogiel */ public class BooleanTransformer implements Transformer { + /** + * This transformer shared instance + */ public static final BooleanTransformer SHARED_INSTANCE = new BooleanTransformer(); @Override diff --git a/src/main/java/com/l2jserver/util/transformer/impl/ByteTransformer.java b/src/main/java/com/l2jserver/util/transformer/impl/ByteTransformer.java index 45c2bc94e..d1c4d815e 100644 --- a/src/main/java/com/l2jserver/util/transformer/impl/ByteTransformer.java +++ b/src/main/java/com/l2jserver/util/transformer/impl/ByteTransformer.java @@ -24,6 +24,9 @@ import com.l2jserver.util.transformer.Transformer; * @author Rogiel */ public class ByteTransformer implements Transformer { + /** + * This transformer shared instance + */ public static final ByteTransformer SHARED_INSTANCE = new ByteTransformer(); @Override diff --git a/src/main/java/com/l2jserver/util/transformer/impl/ClassTransformer.java b/src/main/java/com/l2jserver/util/transformer/impl/ClassTransformer.java index e09799ed8..b5fe0198d 100644 --- a/src/main/java/com/l2jserver/util/transformer/impl/ClassTransformer.java +++ b/src/main/java/com/l2jserver/util/transformer/impl/ClassTransformer.java @@ -24,6 +24,9 @@ import com.l2jserver.util.transformer.Transformer; * @author Rogiel */ public class ClassTransformer implements Transformer> { + /** + * This transformer shared instance + */ public static final ClassTransformer SHARED_INSTANCE = new ClassTransformer(); @Override diff --git a/src/main/java/com/l2jserver/util/transformer/impl/DoubleTransformer.java b/src/main/java/com/l2jserver/util/transformer/impl/DoubleTransformer.java index 99ba434f0..be9f30205 100644 --- a/src/main/java/com/l2jserver/util/transformer/impl/DoubleTransformer.java +++ b/src/main/java/com/l2jserver/util/transformer/impl/DoubleTransformer.java @@ -24,6 +24,9 @@ import com.l2jserver.util.transformer.Transformer; * @author Rogiel */ public class DoubleTransformer implements Transformer { + /** + * This transformer shared instance + */ public static final DoubleTransformer SHARED_INSTANCE = new DoubleTransformer(); @Override diff --git a/src/main/java/com/l2jserver/util/transformer/impl/FileTransformer.java b/src/main/java/com/l2jserver/util/transformer/impl/FileTransformer.java index 72d6b3902..3cecfe42a 100644 --- a/src/main/java/com/l2jserver/util/transformer/impl/FileTransformer.java +++ b/src/main/java/com/l2jserver/util/transformer/impl/FileTransformer.java @@ -26,8 +26,14 @@ import com.l2jserver.util.transformer.Transformer; * @author Rogiel */ public class FileTransformer implements Transformer { + /** + * This transformer shared instance + */ public static final FileTransformer SHARED_INSTANCE = new FileTransformer(); + /** + * The root to resolve relative files + */ private final File root = new File("./"); @Override diff --git a/src/main/java/com/l2jserver/util/transformer/impl/FloatTransformer.java b/src/main/java/com/l2jserver/util/transformer/impl/FloatTransformer.java index b9fb741bf..642641886 100644 --- a/src/main/java/com/l2jserver/util/transformer/impl/FloatTransformer.java +++ b/src/main/java/com/l2jserver/util/transformer/impl/FloatTransformer.java @@ -24,6 +24,9 @@ import com.l2jserver.util.transformer.Transformer; * @author Rogiel */ public class FloatTransformer implements Transformer { + /** + * This transformer shared instance + */ public static final FloatTransformer SHARED_INSTANCE = new FloatTransformer(); @Override diff --git a/src/main/java/com/l2jserver/util/transformer/impl/InetSocketAddressTransformer.java b/src/main/java/com/l2jserver/util/transformer/impl/InetSocketAddressTransformer.java index 7a3579e15..422217bf7 100644 --- a/src/main/java/com/l2jserver/util/transformer/impl/InetSocketAddressTransformer.java +++ b/src/main/java/com/l2jserver/util/transformer/impl/InetSocketAddressTransformer.java @@ -27,6 +27,9 @@ import com.l2jserver.util.transformer.Transformer; */ public class InetSocketAddressTransformer implements Transformer { + /** + * This transformer shared instance + */ public static final InetSocketAddressTransformer SHARED_INSTANCE = new InetSocketAddressTransformer(); @Override diff --git a/src/main/java/com/l2jserver/util/transformer/impl/IntegerTransformer.java b/src/main/java/com/l2jserver/util/transformer/impl/IntegerTransformer.java index e96a8b120..c3fa27fae 100644 --- a/src/main/java/com/l2jserver/util/transformer/impl/IntegerTransformer.java +++ b/src/main/java/com/l2jserver/util/transformer/impl/IntegerTransformer.java @@ -24,6 +24,9 @@ import com.l2jserver.util.transformer.Transformer; * @author Rogiel */ public class IntegerTransformer implements Transformer { + /** + * This transformer shared instance + */ public static final IntegerTransformer SHARED_INSTANCE = new IntegerTransformer(); @Override diff --git a/src/main/java/com/l2jserver/util/transformer/impl/LongTransformer.java b/src/main/java/com/l2jserver/util/transformer/impl/LongTransformer.java index b8e2d6a37..9a7f5e5f8 100644 --- a/src/main/java/com/l2jserver/util/transformer/impl/LongTransformer.java +++ b/src/main/java/com/l2jserver/util/transformer/impl/LongTransformer.java @@ -24,6 +24,9 @@ import com.l2jserver.util.transformer.Transformer; * @author Rogiel */ public class LongTransformer implements Transformer { + /** + * This transformer shared instance + */ public static final LongTransformer SHARED_INSTANCE = new LongTransformer(); @Override diff --git a/src/main/java/com/l2jserver/util/transformer/impl/PathTransformer.java b/src/main/java/com/l2jserver/util/transformer/impl/PathTransformer.java index d6a4603ea..49d205d87 100644 --- a/src/main/java/com/l2jserver/util/transformer/impl/PathTransformer.java +++ b/src/main/java/com/l2jserver/util/transformer/impl/PathTransformer.java @@ -27,6 +27,9 @@ import com.l2jserver.util.transformer.Transformer; * @author Rogiel */ public class PathTransformer implements Transformer { + /** + * This transformer shared instance + */ public static final PathTransformer SHARED_INSTANCE = new PathTransformer(); @Override diff --git a/src/main/java/com/l2jserver/util/transformer/impl/ShortTransformer.java b/src/main/java/com/l2jserver/util/transformer/impl/ShortTransformer.java index 82b9a58c4..9aec6fa4d 100644 --- a/src/main/java/com/l2jserver/util/transformer/impl/ShortTransformer.java +++ b/src/main/java/com/l2jserver/util/transformer/impl/ShortTransformer.java @@ -24,6 +24,9 @@ import com.l2jserver.util.transformer.Transformer; * @author Rogiel */ public class ShortTransformer implements Transformer { + /** + * This transformer shared instance + */ public static final ShortTransformer SHARED_INSTANCE = new ShortTransformer(); @Override diff --git a/src/main/java/com/l2jserver/util/transformer/impl/URITransformer.java b/src/main/java/com/l2jserver/util/transformer/impl/URITransformer.java index 41cb79d15..8d8be794d 100644 --- a/src/main/java/com/l2jserver/util/transformer/impl/URITransformer.java +++ b/src/main/java/com/l2jserver/util/transformer/impl/URITransformer.java @@ -26,6 +26,9 @@ import com.l2jserver.util.transformer.Transformer; * @author Rogiel */ public class URITransformer implements Transformer { + /** + * This transformer shared instance + */ public static final URITransformer SHARED_INSTANCE = new URITransformer(); @Override diff --git a/src/main/java/com/l2jserver/util/transformer/impl/URLTransformer.java b/src/main/java/com/l2jserver/util/transformer/impl/URLTransformer.java index 41c724d04..bd00e45af 100644 --- a/src/main/java/com/l2jserver/util/transformer/impl/URLTransformer.java +++ b/src/main/java/com/l2jserver/util/transformer/impl/URLTransformer.java @@ -28,6 +28,9 @@ import com.l2jserver.util.transformer.Transformer; * @author Rogiel */ public class URLTransformer implements Transformer { + /** + * This transformer shared instance + */ public static final URLTransformer SHARED_INSTANCE = new URLTransformer(); @Override