XML dumps code clean-up
* Moved empire summary generator to a separate package, moved all empire summary data classes to a sub-package of the former * All row mappers for empire summary contents have been moved to separate classes with default access * Added comments to the component and to the mapper classes
This commit is contained in:
parent
2adc754a2c
commit
426a1fdfd4
24 changed files with 557 additions and 254 deletions
legacyworlds-server-interfaces/src/main/java/com/deepclone/lw/interfaces/bt
|
@ -1,9 +1,30 @@
|
|||
package com.deepclone.lw.interfaces.bt;
|
||||
|
||||
|
||||
/**
|
||||
* Empire XML summary generator
|
||||
*
|
||||
* <p>
|
||||
* This interface corresponds to the component which generates XML dumps of an empire's state to be
|
||||
* included in bug reports.
|
||||
*
|
||||
* @author <a href="mailto:tseeker@legacyworlds.com">E. Benoît</a>
|
||||
*/
|
||||
public interface EmpireSummary
|
||||
{
|
||||
|
||||
/**
|
||||
* Generate an empire's XML summary
|
||||
*
|
||||
* <p>
|
||||
* This method retrieves all necessary data from the database and converts it into an XML dump
|
||||
* to be used in the bug report.
|
||||
*
|
||||
* @param empireId
|
||||
* the empire's identifier
|
||||
*
|
||||
* @return the XML summary of the empire's current state
|
||||
*/
|
||||
public String getSummary( int empireId );
|
||||
|
||||
}
|
||||
|
|
Reference in a new issue