Written javadoc for many classes

Signed-off-by: Rogiel <rogiel@rogiel.com>

src/main/java/com/l2jserver/service/database/AbstractDAO.java

@@ -2,7 +2,18 @@ package com.l2jserver.service.database;
 
 import com.google.inject.Inject;
 
+/**
+ * Abstract DAO implementations. Store an instance of {@link DatabaseService}.
+ * 
+ * @author <a href="http://www.rogiel.com">Rogiel</a>
+ * 
+ * @param <T>
+ *            the dao object type
+ */
 public abstract class AbstractDAO<T> implements DataAccessObject<T> {
+	/**
+	 * The database service instance
+	 */
 	protected final DatabaseService database;
 
 	@Inject
@@ -10,6 +21,9 @@ public abstract class AbstractDAO<T> implements DataAccessObject<T> {
 		this.database = database;
 	}
 
+	/**
+	 * @return the database service
+	 */
 	public DatabaseService getDatabase() {
 		return database;
 	}

src/main/java/com/l2jserver/service/database/DB4ODatabaseConfiguration.java

@@ -4,6 +4,11 @@ import java.io.File;
 
 import com.l2jserver.service.configuration.Configuration.ConfigurationName;
 
+/**
+ * Configuration for DB4O Database Service
+ * 
+ * @author <a href="http://www.rogiel.com">Rogiel</a>
+ */
 @ConfigurationName("db4o")
 public interface DB4ODatabaseConfiguration extends DatabaseConfiguration {
 	/**

src/main/java/com/l2jserver/service/database/DB4ODatabaseService.java

@@ -2,6 +2,13 @@ package com.l2jserver.service.database;
 
 import com.l2jserver.service.AbstractService;
 
+/**
+ * Database service implementation for DB4O database engine.
+ * <p>
+ * Note that this is not implemented yet!
+ * 
+ * @author <a href="http://www.rogiel.com">Rogiel</a>
+ */
 public class DB4ODatabaseService extends AbstractService implements
 		DatabaseService {
 }

src/main/java/com/l2jserver/service/database/DatabaseConfiguration.java

@@ -3,6 +3,12 @@ package com.l2jserver.service.database;
 import com.l2jserver.service.configuration.Configuration;
 import com.l2jserver.service.configuration.Configuration.ConfigurationName;
 
+/**
+ * Database service configuration
+ * 
+ * @author <a href="http://www.rogiel.com">Rogiel</a>
+ * @see Configuration
+ */
 @ConfigurationName("database")
 public interface DatabaseConfiguration extends Configuration {
 

src/main/java/com/l2jserver/service/database/DatabaseService.java

@@ -2,6 +2,12 @@ package com.l2jserver.service.database;
 
 import com.l2jserver.service.Service;
 
+/**
+ * The database service manages connection between the {@link DataAccessObject}
+ * implementation and the database.
+ * 
+ * @author <a href="http://www.rogiel.com">Rogiel</a>
+ */
 public interface DatabaseService extends Service {
 
 }

src/main/java/com/l2jserver/service/database/MySQLDatabaseConfiguration.java

@@ -1,5 +1,10 @@
 package com.l2jserver.service.database;
 
+/**
+ * Configuration interface for {@link MySQLDatabaseService}.
+ * 
+ * @author <a href="http://www.rogiel.com">Rogiel</a>
+ */
 public interface MySQLDatabaseConfiguration extends DatabaseConfiguration {
 	/**
 	 * @return the jdbc url

src/main/java/com/l2jserver/service/database/MySQLDatabaseService.java

@@ -7,6 +7,8 @@ import java.sql.SQLException;
 import java.util.Iterator;
 import java.util.List;
 
+import javax.sql.DataSource;
+
 import org.apache.commons.dbcp.ConnectionFactory;
 import org.apache.commons.dbcp.DriverManagerConnectionFactory;
 import org.apache.commons.dbcp.PoolableConnectionFactory;
@@ -24,16 +26,39 @@ import com.l2jserver.service.configuration.ConfigurationService;
 import com.l2jserver.util.ArrayIterator;
 import com.l2jserver.util.factory.CollectionFactory;
 
+/**
+ * The database service implementation for MySQL database
+ * 
+ * @author <a href="http://www.rogiel.com">Rogiel</a>
+ */
 public class MySQLDatabaseService extends AbstractService implements
 		DatabaseService {
+	/**
+	 * The configuration object
+	 */
 	private final MySQLDatabaseConfiguration config;
+	/**
+	 * The logger
+	 */
 	private final Logger logger = LoggerFactory
 			.getLogger(MySQLDatabaseService.class);
 
+	/**
+	 * The database connection pool
+	 */
 	private ObjectPool connectionPool;
+	/**
+	 * The dayabase connection factory
+	 */
 	private ConnectionFactory connectionFactory;
+	/**
+	 * The poolable connection factory
+	 */
 	@SuppressWarnings("unused")
 	private PoolableConnectionFactory poolableConnectionFactory;
+	/**
+	 * The connection {@link DataSource}.
+	 */
 	private PoolingDataSource dataSource;
 
 	@Inject
@@ -51,6 +76,15 @@ public class MySQLDatabaseService extends AbstractService implements
 		dataSource = new PoolingDataSource(connectionPool);
 	}
 
+	/**
+	 * Executes an <tt>query</tt> in the database.
+	 * 
+	 * @param <T>
+	 *            the query return type
+	 * @param query
+	 *            the query
+	 * @return an instance of <tt>T</tt>
+	 */
 	public <T> T query(Query<T> query) {
 		try {
 			final Connection conn = dataSource.getConnection();
@@ -84,17 +118,59 @@ public class MySQLDatabaseService extends AbstractService implements
 		}
 	}
 
+	/**
+	 * The query interface. The query will receive an connection an will be
+	 * executed. The can return return a value if required.
+	 * 
+	 * @author <a href="http://www.rogiel.com">Rogiel</a>
+	 * 
+	 * @param <R>
+	 *            the return type
+	 */
 	public interface Query<R> {
+		/**
+		 * Execute the query in <tt>conn</tt>
+		 * 
+		 * @param conn
+		 *            the connection
+		 * @return the query return value
+		 * @throws SQLException
+		 */
 		R query(Connection conn) throws SQLException;
 	}
 
+	/**
+	 * This query is used for the following statements:
+	 * <ul>
+	 * <li>INSERT INTO</li>
+	 * <li>UPDATE</li>
+	 * <li>DELETE FROM</li>
+	 * </ul>
+	 * 
+	 * @author <a href="http://www.rogiel.com">Rogiel</a>
+	 * 
+	 * @param <T>
+	 *            the query return type
+	 */
 	public static abstract class InsertUpdateQuery<T> implements Query<Integer> {
 		private final Iterator<T> iterator;
 
+		/**
+		 * Creates a new query for <tt>objects</tt>
+		 * 
+		 * @param objects
+		 *            the object list
+		 */
 		public InsertUpdateQuery(T... objects) {
 			this(new ArrayIterator<T>(objects));
 		}
 
+		/**
+		 * Create a new query for objects in <tt>iterator</tt>
+		 * 
+		 * @param iterator
+		 *            the object iterator
+		 */
 		public InsertUpdateQuery(Iterator<T> iterator) {
 			this.iterator = iterator;
 		}
@@ -118,16 +194,46 @@ public class MySQLDatabaseService extends AbstractService implements
 			return rows;
 		}
 
+		/**
+		 * Creates the <b>prepared</b> query for execution
+		 * 
+		 * @return the <b>prepared</b> query
+		 */
 		protected abstract String query();
 
+		/**
+		 * Set the parameters for in <tt>statement</tt> for <tt>object</tt>
+		 * 
+		 * @param st
+		 *            the prepared statement
+		 * @param object
+		 *            the object
+		 * @throws SQLException
+		 */
 		protected abstract void parametize(PreparedStatement st, T object)
 				throws SQLException;
 
+		/**
+		 * Return the key mapper. Can be null if no generated keys are used or
+		 * are not important.
+		 * 
+		 * @param object
+		 *            the object
+		 * @return the key mapper
+		 */
 		protected Mapper<T> keyMapper(T object) {
 			return null;
 		}
 	}
 
+	/**
+	 * An select query that returns a list of objects of type <tt>T</tt>
+	 * 
+	 * @author <a href="http://www.rogiel.com">Rogiel</a>
+	 * 
+	 * @param <T>
+	 *            the query return type
+	 */
 	public static abstract class SelectListQuery<T> implements Query<List<T>> {
 		@Override
 		public List<T> query(Connection conn) throws SQLException {
@@ -142,14 +248,46 @@ public class MySQLDatabaseService extends AbstractService implements
 			return list;
 		}
 
+		/**
+		 * Creates the <b>prepared</b> query for execution
+		 * 
+		 * @return the <b>prepared</b> query
+		 */
 		protected abstract String query();
 
+		/**
+		 * Set the parameters for in <tt>statement</tt> for <tt>object</tt>
+		 * 
+		 * @param st
+		 *            the prepared statement
+		 * @param object
+		 *            the object
+		 * @throws SQLException
+		 */
 		protected void parametize(PreparedStatement st) throws SQLException {
 		}
 
+		/**
+		 * Return the mapper that will bind {@link ResultSet} objects into an
+		 * <tt>T</tt> object instance. The mapper will need to create the object
+		 * instance.
+		 * <p>
+		 * <b>Note</b>: This method will be called for each row, an thus is a
+		 * good idea to create a new instance on each call!
+		 * 
+		 * @return the mapper instance
+		 */
 		protected abstract Mapper<T> mapper();
 	}
 
+	/**
+	 * An select query that returns a single object of type <tt>T</tt>
+	 * 
+	 * @author <a href="http://www.rogiel.com">Rogiel</a>
+	 * 
+	 * @param <T>
+	 *            the query return type
+	 */
 	public static abstract class SelectSingleQuery<T> implements Query<T> {
 		@Override
 		public T query(Connection conn) throws SQLException {
@@ -163,15 +301,55 @@ public class MySQLDatabaseService extends AbstractService implements
 			return null;
 		}
 
+		/**
+		 * Creates the <b>prepared</b> query for execution
+		 * 
+		 * @return the <b>prepared</b> query
+		 */
 		protected abstract String query();
 
-		protected abstract void parametize(PreparedStatement st)
-				throws SQLException;
+		/**
+		 * Set the parameters for in <tt>statement</tt> for <tt>object</tt>
+		 * 
+		 * @param st
+		 *            the prepared statement
+		 * @param object
+		 *            the object
+		 * @throws SQLException
+		 */
+		protected void parametize(PreparedStatement st) throws SQLException {
+		}
 
+		/**
+		 * Return the mapper that will bind {@link ResultSet} objects into an
+		 * <tt>T</tt> object instance. The mapper will need to create the object
+		 * instance.
+		 * 
+		 * @return the mapper
+		 */
 		protected abstract Mapper<T> mapper();
 	}
 
+	/**
+	 * The {@link Mapper} maps an {@link ResultSet} into an object <tt>T</tt>
+	 * 
+	 * @author <a href="http://www.rogiel.com">Rogiel</a>
+	 * 
+	 * @param <T>
+	 *            the object type
+	 */
 	public interface Mapper<T> {
+		/**
+		 * Map the result set value into an object.
+		 * <p>
+		 * <b>Note</b>: it is required to call {@link ResultSet#next()}, since
+		 * it is called by the {@link Query}.
+		 * 
+		 * @param rs
+		 *            the result set
+		 * @return the created instance
+		 * @throws SQLException
+		 */
 		T map(ResultSet rs) throws SQLException;
 	}
 }