Update JavaDoc and move the model.settings package to model.entity.settings.

This commit is contained in:
Major-
2014-07-10 15:58:31 +01:00
parent 465d820890
commit 3654d28b18
31 changed files with 38 additions and 38 deletions
@@ -1,7 +1,7 @@
package org.apollo.game.command; package org.apollo.game.command;
import org.apollo.game.model.entity.Player; import org.apollo.game.model.entity.Player;
import org.apollo.game.model.settings.PrivilegeLevel; import org.apollo.game.model.entity.setting.PrivilegeLevel;
/** /**
* An interface which should be implemented to listen to {@link Command}s. * An interface which should be implemented to listen to {@link Command}s.
@@ -5,7 +5,7 @@ import org.apollo.game.event.handler.EventHandlerContext;
import org.apollo.game.event.impl.PlayerDesignEvent; import org.apollo.game.event.impl.PlayerDesignEvent;
import org.apollo.game.model.Appearance; import org.apollo.game.model.Appearance;
import org.apollo.game.model.entity.Player; import org.apollo.game.model.entity.Player;
import org.apollo.game.model.settings.Gender; import org.apollo.game.model.entity.setting.Gender;
/** /**
* An {@link EventHandler} that verifies {@link PlayerDesignEvent}s. * An {@link EventHandler} that verifies {@link PlayerDesignEvent}s.
@@ -1,7 +1,7 @@
package org.apollo.game.event.impl; package org.apollo.game.event.impl;
import org.apollo.game.event.Event; import org.apollo.game.event.Event;
import org.apollo.game.model.settings.PrivilegeLevel; import org.apollo.game.model.entity.setting.PrivilegeLevel;
/** /**
* An {@link Event} sent to the client that forwards a private message. * An {@link Event} sent to the client that forwards a private message.
@@ -1,7 +1,7 @@
package org.apollo.game.event.impl; package org.apollo.game.event.impl;
import org.apollo.game.event.Event; import org.apollo.game.event.Event;
import org.apollo.game.model.settings.ServerStatus; import org.apollo.game.model.entity.setting.ServerStatus;
/** /**
* An {@link Event} sent to the client to update the friend server status. * An {@link Event} sent to the client to update the friend server status.
@@ -1,7 +1,7 @@
package org.apollo.game.event.impl; package org.apollo.game.event.impl;
import org.apollo.game.event.Event; import org.apollo.game.event.Event;
import org.apollo.game.model.settings.PrivacyState; import org.apollo.game.model.entity.setting.PrivacyState;
/** /**
* An {@link Event} sent both by and to the client to update the public chat, private (friend) chat, and trade chat * An {@link Event} sent both by and to the client to update the public chat, private (friend) chat, and trade chat
+1 -1
View File
@@ -1,6 +1,6 @@
package org.apollo.game.model; package org.apollo.game.model;
import org.apollo.game.model.settings.Gender; import org.apollo.game.model.entity.setting.Gender;
/** /**
* Represents the appearance of a player. * Represents the appearance of a player.
+3 -3
View File
@@ -18,6 +18,9 @@ import org.apollo.game.event.impl.UpdateRunEnergyEvent;
import org.apollo.game.model.Appearance; import org.apollo.game.model.Appearance;
import org.apollo.game.model.Position; import org.apollo.game.model.Position;
import org.apollo.game.model.World; import org.apollo.game.model.World;
import org.apollo.game.model.entity.setting.PrivacyState;
import org.apollo.game.model.entity.setting.PrivilegeLevel;
import org.apollo.game.model.entity.setting.ScreenBrightness;
import org.apollo.game.model.inter.InterfaceConstants; import org.apollo.game.model.inter.InterfaceConstants;
import org.apollo.game.model.inter.InterfaceListener; import org.apollo.game.model.inter.InterfaceListener;
import org.apollo.game.model.inter.InterfaceSet; import org.apollo.game.model.inter.InterfaceSet;
@@ -30,9 +33,6 @@ import org.apollo.game.model.inv.InventoryConstants;
import org.apollo.game.model.inv.InventoryListener; import org.apollo.game.model.inv.InventoryListener;
import org.apollo.game.model.inv.SynchronizationInventoryListener; import org.apollo.game.model.inv.SynchronizationInventoryListener;
import org.apollo.game.model.inv.Inventory.StackMode; import org.apollo.game.model.inv.Inventory.StackMode;
import org.apollo.game.model.settings.PrivacyState;
import org.apollo.game.model.settings.PrivilegeLevel;
import org.apollo.game.model.settings.ScreenBrightness;
import org.apollo.game.model.skill.LevelUpSkillListener; import org.apollo.game.model.skill.LevelUpSkillListener;
import org.apollo.game.model.skill.SynchronizationSkillListener; import org.apollo.game.model.skill.SynchronizationSkillListener;
import org.apollo.game.sync.block.SynchronizationBlock; import org.apollo.game.sync.block.SynchronizationBlock;
@@ -1,4 +1,4 @@
package org.apollo.game.model.settings; package org.apollo.game.model.entity.setting;
/** /**
* An enumeration containing the two genders (male and female). This enumeration relies on the ordering of the elements * An enumeration containing the two genders (male and female). This enumeration relies on the ordering of the elements
@@ -1,4 +1,4 @@
package org.apollo.game.model.settings; package org.apollo.game.model.entity.setting;
/** /**
* An enumeration representing the different privacy states for public, private and trade chat. This enumeration relies * An enumeration representing the different privacy states for public, private and trade chat. This enumeration relies
@@ -1,4 +1,4 @@
package org.apollo.game.model.settings; package org.apollo.game.model.entity.setting;
/** /**
* An enumeration with the different privilege levels a player can have. This enumeration relies on the ordering of the * An enumeration with the different privilege levels a player can have. This enumeration relies on the ordering of the
@@ -1,4 +1,4 @@
package org.apollo.game.model.settings; package org.apollo.game.model.entity.setting;
/** /**
* An enumeration representing the brightness of a player's screen. This enumeration relies on the ordering of the * An enumeration representing the brightness of a player's screen. This enumeration relies on the ordering of the
@@ -1,4 +1,4 @@
package org.apollo.game.model.settings; package org.apollo.game.model.entity.setting;
/** /**
* Represents the status of the friend server. This enumeration relies on the ordering of the elements within, which * Represents the status of the friend server. This enumeration relies on the ordering of the elements within, which
@@ -1,4 +1,4 @@
/** /**
* Contains player setting or customisation-related classes. * Contains player setting or customisation-related classes.
*/ */
package org.apollo.game.model.settings; package org.apollo.game.model.entity.setting;
@@ -1,7 +1,7 @@
package org.apollo.game.sync.block; package org.apollo.game.sync.block;
import org.apollo.game.event.impl.ChatEvent; import org.apollo.game.event.impl.ChatEvent;
import org.apollo.game.model.settings.PrivilegeLevel; import org.apollo.game.model.entity.setting.PrivilegeLevel;
/** /**
* The chat {@link SynchronizationBlock}. Only players can utilise this block. * The chat {@link SynchronizationBlock}. Only players can utilise this block.
@@ -13,11 +13,11 @@ import org.apollo.game.model.Position;
import org.apollo.game.model.entity.Player; import org.apollo.game.model.entity.Player;
import org.apollo.game.model.entity.Skill; import org.apollo.game.model.entity.Skill;
import org.apollo.game.model.entity.SkillSet; import org.apollo.game.model.entity.SkillSet;
import org.apollo.game.model.entity.setting.Gender;
import org.apollo.game.model.entity.setting.PrivacyState;
import org.apollo.game.model.entity.setting.PrivilegeLevel;
import org.apollo.game.model.entity.setting.ScreenBrightness;
import org.apollo.game.model.inv.Inventory; import org.apollo.game.model.inv.Inventory;
import org.apollo.game.model.settings.Gender;
import org.apollo.game.model.settings.PrivacyState;
import org.apollo.game.model.settings.PrivilegeLevel;
import org.apollo.game.model.settings.ScreenBrightness;
import org.apollo.io.player.PlayerLoader; import org.apollo.io.player.PlayerLoader;
import org.apollo.io.player.PlayerLoaderResponse; import org.apollo.io.player.PlayerLoaderResponse;
import org.apollo.net.codec.login.LoginConstants; import org.apollo.net.codec.login.LoginConstants;
@@ -2,7 +2,7 @@ package org.apollo.io.player.impl;
import org.apollo.game.model.Position; import org.apollo.game.model.Position;
import org.apollo.game.model.entity.Player; import org.apollo.game.model.entity.Player;
import org.apollo.game.model.settings.PrivilegeLevel; import org.apollo.game.model.entity.setting.PrivilegeLevel;
import org.apollo.io.player.PlayerLoader; import org.apollo.io.player.PlayerLoader;
import org.apollo.io.player.PlayerLoaderResponse; import org.apollo.io.player.PlayerLoaderResponse;
import org.apollo.net.codec.login.LoginConstants; import org.apollo.net.codec.login.LoginConstants;
+2 -2
View File
@@ -1,8 +1,8 @@
package org.apollo.net; package org.apollo.net;
import io.netty.channel.Channel; import io.netty.channel.Channel;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.ChannelHandler.Sharable; import io.netty.channel.ChannelHandler.Sharable;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.ChannelInboundHandlerAdapter; import io.netty.channel.ChannelInboundHandlerAdapter;
import io.netty.handler.codec.http.HttpRequest; import io.netty.handler.codec.http.HttpRequest;
@@ -18,7 +18,7 @@ import org.apollo.net.session.Session;
import org.apollo.net.session.UpdateSession; import org.apollo.net.session.UpdateSession;
/** /**
* An implementation of {@link SimpleChannelUpstreamHandler} which handles incoming upstream events from Netty. * An implementation of {@link ChannelInboundHandlerAdapter} which handles incoming upstream events from Netty.
* *
* @author Graham * @author Graham
*/ */
@@ -9,7 +9,7 @@ import io.netty.handler.codec.http.HttpResponseEncoder;
import io.netty.handler.timeout.IdleStateHandler; import io.netty.handler.timeout.IdleStateHandler;
/** /**
* A {@link ChannelPipelineFactory} for the HTTP protocol. * A {@link ChannelInitializer} for the HTTP protocol.
* *
* @author Graham * @author Graham
*/ */
@@ -15,7 +15,7 @@ import org.apollo.net.codec.jaggrab.JagGrabRequestDecoder;
import org.apollo.net.codec.jaggrab.JagGrabResponseEncoder; import org.apollo.net.codec.jaggrab.JagGrabResponseEncoder;
/** /**
* A {@link ChannelPipelineFactory} for the JAGGRAB protocol. * A {@link ChannelInitializer} for the JAGGRAB protocol.
* *
* @author Graham * @author Graham
*/ */
@@ -8,7 +8,7 @@ import io.netty.handler.timeout.IdleStateHandler;
import org.apollo.net.codec.handshake.HandshakeDecoder; import org.apollo.net.codec.handshake.HandshakeDecoder;
/** /**
* A {@link ChannelPipelineFactory} which creates {@link ChannelPipeline}s for the service pipeline. * A {@link ChannelInitializer} for the service pipeline.
* *
* @author Graham * @author Graham
*/ */
@@ -10,7 +10,7 @@ import org.apollo.net.release.EventDecoder;
import org.apollo.net.release.Release; import org.apollo.net.release.Release;
/** /**
* A {@link OneToOneDecoder} that decodes {@link GamePacket}s into {@link Event}s. * A {@link MessageToMessageDecoder} that decodes {@link GamePacket}s into {@link Event}s.
* *
* @author Graham * @author Graham
*/ */
@@ -10,7 +10,7 @@ import org.apollo.net.release.EventEncoder;
import org.apollo.net.release.Release; import org.apollo.net.release.Release;
/** /**
* A {@link OneToOneEncoder} which encodes {@link Event}s into {@link GamePacket}s. * A {@link MessageToMessageEncoder} which encodes {@link Event}s into {@link GamePacket}s.
* *
* @author Graham * @author Graham
*/ */
@@ -12,7 +12,7 @@ import net.burtleburtle.bob.rand.IsaacRandom;
import org.apollo.net.meta.PacketType; import org.apollo.net.meta.PacketType;
/** /**
* A {@link OneToOneEncoder} which encodes in-game packets. * A {@link MessageToMessageEncoder} which encodes in-game packets.
* *
* @author Graham * @author Graham
*/ */
@@ -12,8 +12,8 @@ import org.apollo.net.codec.update.UpdateDecoder;
import org.apollo.net.codec.update.UpdateEncoder; import org.apollo.net.codec.update.UpdateEncoder;
/** /**
* A {@link FrameDecoder} which decodes the handshake and makes changes to the pipeline as appropriate for the selected * A {@link ByteToMessageDecoder} which decodes the handshake and makes changes to the pipeline as appropriate for the
* service. * selected service.
* *
* @author Graham * @author Graham
*/ */
@@ -6,7 +6,7 @@ import io.netty.handler.codec.MessageToMessageDecoder;
import java.util.List; import java.util.List;
/** /**
* A {@link OneToOneDecoder} for the JAGGRAB protocol. * A {@link MessageToMessageDecoder} for the JAGGRAB protocol.
* *
* @author Graham * @author Graham
*/ */
@@ -6,7 +6,7 @@ import io.netty.handler.codec.MessageToMessageEncoder;
import java.util.List; import java.util.List;
/** /**
* A {@link OneToOneEncoder} for the JAGGRAB protocol. * A {@link MessageToMessageEncoder} for the JAGGRAB protocol.
* *
* @author Graham * @author Graham
*/ */
@@ -7,7 +7,7 @@ import io.netty.handler.codec.MessageToMessageEncoder;
import java.util.List; import java.util.List;
/** /**
* A class which encodes login response messages. * A {@link MessageToMessageEncoder} which encodes login response messages.
* *
* @author Graham * @author Graham
*/ */
@@ -2,7 +2,7 @@ package org.apollo.net.release.r317;
import org.apollo.game.event.impl.PlayerDesignEvent; import org.apollo.game.event.impl.PlayerDesignEvent;
import org.apollo.game.model.Appearance; import org.apollo.game.model.Appearance;
import org.apollo.game.model.settings.Gender; import org.apollo.game.model.entity.setting.Gender;
import org.apollo.net.codec.game.DataType; import org.apollo.net.codec.game.DataType;
import org.apollo.net.codec.game.GamePacket; import org.apollo.net.codec.game.GamePacket;
import org.apollo.net.codec.game.GamePacketReader; import org.apollo.net.codec.game.GamePacketReader;
@@ -9,8 +9,8 @@ import org.apollo.game.model.Item;
import org.apollo.game.model.Position; import org.apollo.game.model.Position;
import org.apollo.game.model.def.EquipmentDefinition; import org.apollo.game.model.def.EquipmentDefinition;
import org.apollo.game.model.entity.EquipmentConstants; import org.apollo.game.model.entity.EquipmentConstants;
import org.apollo.game.model.entity.setting.Gender;
import org.apollo.game.model.inv.Inventory; import org.apollo.game.model.inv.Inventory;
import org.apollo.game.model.settings.Gender;
import org.apollo.game.sync.block.AnimationBlock; import org.apollo.game.sync.block.AnimationBlock;
import org.apollo.game.sync.block.AppearanceBlock; import org.apollo.game.sync.block.AppearanceBlock;
import org.apollo.game.sync.block.ChatBlock; import org.apollo.game.sync.block.ChatBlock;
@@ -2,7 +2,7 @@ package org.apollo.net.release.r377;
import org.apollo.game.event.impl.PlayerDesignEvent; import org.apollo.game.event.impl.PlayerDesignEvent;
import org.apollo.game.model.Appearance; import org.apollo.game.model.Appearance;
import org.apollo.game.model.settings.Gender; import org.apollo.game.model.entity.setting.Gender;
import org.apollo.net.codec.game.DataType; import org.apollo.net.codec.game.DataType;
import org.apollo.net.codec.game.GamePacket; import org.apollo.net.codec.game.GamePacket;
import org.apollo.net.codec.game.GamePacketReader; import org.apollo.net.codec.game.GamePacketReader;
@@ -9,8 +9,8 @@ import org.apollo.game.model.Item;
import org.apollo.game.model.Position; import org.apollo.game.model.Position;
import org.apollo.game.model.def.EquipmentDefinition; import org.apollo.game.model.def.EquipmentDefinition;
import org.apollo.game.model.entity.EquipmentConstants; import org.apollo.game.model.entity.EquipmentConstants;
import org.apollo.game.model.entity.setting.Gender;
import org.apollo.game.model.inv.Inventory; import org.apollo.game.model.inv.Inventory;
import org.apollo.game.model.settings.Gender;
import org.apollo.game.sync.block.AnimationBlock; import org.apollo.game.sync.block.AnimationBlock;
import org.apollo.game.sync.block.AppearanceBlock; import org.apollo.game.sync.block.AppearanceBlock;
import org.apollo.game.sync.block.ChatBlock; import org.apollo.game.sync.block.ChatBlock;