From 6b8686bb04a7ccd2a4f20ac4332c91fc5e333cda Mon Sep 17 00:00:00 2001
From: Doublestrike <doublestrike@cardforge.org>
Date: Thu, 1 Sep 2011 11:37:02 +0000
Subject: [PATCH] Renamed "getOpponents()" to "generateBattles()" in
 QuestBattleManager and QuestBattle.

Note: AllZoneUtil already has a method called getOpponents.

Updated references.
---
 .../forge/quest/data/QuestBattleManager.java  | 37 ++++++++++++-------
 .../forge/quest/gui/main/QuestBattle.java     |  2 +-
 2 files changed, 24 insertions(+), 15 deletions(-)

diff --git a/src/main/java/forge/quest/data/QuestBattleManager.java b/src/main/java/forge/quest/data/QuestBattleManager.java
index 1556e1c2ebd..c5314d89661 100644
--- a/src/main/java/forge/quest/data/QuestBattleManager.java
+++ b/src/main/java/forge/quest/data/QuestBattleManager.java
@@ -40,6 +40,8 @@ public class QuestBattleManager {
 
     /**
      * <p>removeAIDeck.</p>
+     * Removes a deck object stored in the 
+     *{@link forge.quest.gui.main.aiDecks} map.
      *
      * @param deckName a {@link java.lang.String} object.
      */
@@ -49,6 +51,8 @@ public class QuestBattleManager {
 
     /**
      * <p>addAIDeck.</p>
+     * Adds a deck object stored in the 
+     *{@link forge.quest.gui.main.aiDecks} map.
      *
      * @param d a {@link forge.deck.Deck} object.
      */
@@ -73,6 +77,17 @@ public class QuestBattleManager {
         return aiDecks.get(deckName);
     }
     
+    /**
+     * <p>getAIDeckNames.</p>
+     *  Returns a list of decks stored in the
+     *  {@link forge.quest.gui.main.aiDecks} map. 
+     *
+     * @return a {@link java.util.List} object.
+     */
+    public static List<String> getAIDeckNames() {
+        return new ArrayList<String>(aiDecks.keySet());
+    }
+    
     /**
      * <p>getDeckFromFile.</p>
      * Returns a deck object built from a file name.
@@ -85,18 +100,12 @@ public class QuestBattleManager {
         final DeckManager manager = new DeckManager(file);
         return manager.getDeck(deckName);
     } 
-    
-    /**
-     * <p>getAIDeckNames.</p>
-     *
-     * @return a {@link java.util.List} object.
-     */
-    public static List<String> getAIDeckNames() {
-        return new ArrayList<String>(aiDecks.keySet());
-    }
 
     /**
      * <p>getOpponent.</p>
+     * 
+     * Badly named; AllZoneUtil already has a method called getOpponents.
+     * ?????
      *
      * @param aiDeck a {@link java.util.List} object.
      * @param number a int.
@@ -108,16 +117,16 @@ public class QuestBattleManager {
         Collections.shuffle(deckListCopy, new Random(AllZone.getQuestData().getRandomSeed()));
 
         return deckListCopy.get(number);
-
     }
 
 
     /**
-     * <p>getOpponents.</p>
+     * <p>generateBattles.</p>
+     * Generates an array of new opponents based on current win conditions.
      *
      * @return an array of {@link java.lang.String} objects.
      */
-    public static String[] getOpponents() {
+    public static String[] generateBattles() {
         int index = AllZone.getQuestData().getDifficultyIndex();
 
         if (AllZone.getQuestData().getWin() < QuestPreferences.getWinsForMediumAI(index)) {
@@ -163,6 +172,7 @@ public class QuestBattleManager {
 
     /**
      * <p>readFile.</p>
+     * A reader util for accessing the AI deck list text files.
      *
      * @param file a {@link java.io.File} object.
      * @param aiDecks a {@link java.util.List} object.
@@ -172,7 +182,7 @@ public class QuestBattleManager {
         ArrayList<String> list = FileUtil.readFile(file);
 
         //remove any blank lines
-        ArrayList<String> noBlankLines = new ArrayList<String>();
+         ArrayList<String> noBlankLines = new ArrayList<String>();
         String s;
         for (String aList : list) {
             s = aList.trim();
@@ -188,7 +198,6 @@ public class QuestBattleManager {
                     file);
         }
 
-
         for (String aList : list) {
             if (!aiDecks.contains(aList)) {
                 aiDecks.add(aList);
diff --git a/src/main/java/forge/quest/gui/main/QuestBattle.java b/src/main/java/forge/quest/gui/main/QuestBattle.java
index d68ea41176a..90f40d18e6e 100644
--- a/src/main/java/forge/quest/gui/main/QuestBattle.java
+++ b/src/main/java/forge/quest/gui/main/QuestBattle.java
@@ -56,7 +56,7 @@ public class QuestBattle extends QuestSelectablePanel {
     public static List<QuestSelectablePanel> getBattles() {
         List<QuestSelectablePanel> opponentList = new ArrayList<QuestSelectablePanel>();
 
-        String[] oppDecks = QuestBattleManager.getOpponents();
+        String[] oppDecks = QuestBattleManager.generateBattles();
         for (String oppDeckName : oppDecks) {
             // Get deck object and properties for this opponent.
             oppDeck    = QuestBattleManager.getAIDeckFromFile(oppDeckName);