Gridarta Editor
CollectArchesAction.java
Go to the documentation of this file.
1 /*
2  * Gridarta MMORPG map editor for Crossfire, Daimonin and similar games.
3  * Copyright (C) 2000-2023 The Gridarta Developers.
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License along
16  * with this program; if not, write to the Free Software Foundation, Inc.,
17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18  */
19 
20 package net.sf.gridarta.action;
21 
22 import java.awt.Component;
23 import java.io.IOException;
24 import javax.swing.Action;
25 import javax.swing.JFrame;
35 import net.sf.gridarta.utils.Exiter;
37 import net.sf.japi.swing.action.ActionBuilder;
38 import net.sf.japi.swing.action.ActionBuilderFactory;
39 import net.sf.japi.swing.action.ActionMethod;
40 import net.sf.japi.swing.misc.Progress;
41 import net.sf.japi.swing.misc.ProgressDisplay;
42 import org.apache.log4j.Category;
43 import org.apache.log4j.Logger;
44 import org.jetbrains.annotations.NotNull;
45 import org.jetbrains.annotations.Nullable;
46 
51 public class CollectArchesAction<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> implements EditorAction {
52 
56  @NotNull
57  private static final ActionBuilder ACTION_BUILDER = ActionBuilderFactory.getInstance().getActionBuilder("net.sf.gridarta");
58 
62  @NotNull
63  private static final Category LOG = Logger.getLogger(CollectArchesAction.class);
64 
68  @NotNull
70 
74  @NotNull
76 
80  @NotNull
81  private final JFrame parent;
82 
87  @Nullable
88  private volatile Collector collector;
89 
94  @Nullable
95  private Action action;
96 
104  public CollectArchesAction(@NotNull final ProjectSettings projectSettings, @NotNull final AbstractResources<G, A, R> resources, @NotNull final Exiter exiter, @NotNull final JFrame parent) {
105  this.projectSettings = projectSettings;
106  this.resources = resources;
107  this.parent = parent;
108  exiter.addExiterListener(newExiterListener());
109  }
110 
114  @ActionMethod
115  public void collectArches() {
116  doCollectArches(true);
117  }
118 
119  @Override
120  public void setAction(@NotNull final Action action, @NotNull final String name) {
121  this.action = action;
122  updateAction();
123  }
124 
130  private boolean doCollectArches(final boolean performAction) {
131  synchronized (this) {
132  if (collector != null || !resources.canWriteCollected()) {
133  return false;
134  }
135 
136  if (performAction) {
137  final Progress progress = new AsynchronousProgress(new ProgressDisplay(parent, ActionBuilderUtils.getString(ACTION_BUILDER, "archCollectTitle"), 0, ActionBuilderUtils.getString(ACTION_BUILDER, "archCollectArches")));
138  final Progress collectArches = new Progress() {
139 
140  @Override
141  public void finished() {
142  progress.finished();
143  collector = null;
144  updateAction();
145  }
146 
147  @Override
148  public Component getParentComponent() {
149  return progress.getParentComponent();
150  }
151 
152  @Override
153  public void setLabel(final String msg, final int max) {
154  progress.setLabel(msg, max);
155  }
156 
157  @Override
158  public void setValue(final int value) {
159  progress.setValue(value);
160  }
161 
162  };
163 
165  assert collector != null;
166  collector.start();
167  updateAction();
168  }
169  }
170 
171  return true;
172  }
173 
177  private void updateAction() {
178  if (action != null) {
179  action.setEnabled(doCollectArches(false));
180  }
181  }
182 
188  @NotNull
190  return new ExiterListener() {
191 
192  @Override
193  public void preExitNotify() {
194  // ignore
195  }
196 
197  @Override
198  public void appExitNotify() {
199  // ignore
200  }
201 
202  @Override
203  public void waitExitNotify() {
204  final Collector tmp = collector;
205  if (tmp != null) {
206  try {
207  tmp.waitUntilFinished();
208  } catch (final InterruptedException ignored) {
209  Thread.currentThread().interrupt();
210  LOG.warn("DelayedMapModelListenerManager was interrupted");
211  } catch (final IOException ex) {
212  ACTION_BUILDER.showMessageDialog(parent, "archCollectErrorIOException", "arches, animations and animtree, images", ex);
213  }
214  }
215  }
216 
217  };
218  }
219 
220 }
name
name
Definition: ArchetypeTypeSetParserTest-ignoreDefaultAttribute1-result.txt:2
net.sf.gridarta.action.CollectArchesAction.updateAction
void updateAction()
Updates the action's enabled state.
Definition: CollectArchesAction.java:177
net.sf.gridarta
Base package of all Gridarta classes.
net.sf.gridarta.commands.Collector
A Collector is capable of iterating over a collection of {Collectables} and collecting them in a sepa...
Definition: Collector.java:35
net.sf.gridarta.action.CollectArchesAction.collectArches
void collectArches()
Runs the archetype collection.
Definition: CollectArchesAction.java:115
net.sf
net.sf.gridarta.commands.Collector.waitUntilFinished
void waitUntilFinished()
Waits until collection has finished.
Definition: Collector.java:102
net.sf.gridarta.action.CollectArchesAction.LOG
static final Category LOG
The Logger for printing log messages.
Definition: CollectArchesAction.java:63
net.sf.gridarta.model.archetype
Definition: AbstractArchetype.java:20
net.sf.gridarta.model.gameobject.GameObject
Reflects a game object (object on a map).
Definition: GameObject.java:36
net.sf.gridarta.action.CollectArchesAction.setAction
void setAction(@NotNull final Action action, @NotNull final String name)
Sets the Action instance for this editor action.
Definition: CollectArchesAction.java:120
net.sf.gridarta.gui
Graphical User Interface of Gridarta.
net.sf.gridarta.action.CollectArchesAction.projectSettings
final ProjectSettings projectSettings
The project settings instance.
Definition: CollectArchesAction.java:69
net.sf.gridarta.action.CollectArchesAction.newExiterListener
ExiterListener newExiterListener()
Creates a new ExiterListener that delays application exit until archetype collection has finished.
Definition: CollectArchesAction.java:189
net.sf.gridarta.model.gameobject
GameObjects are the objects based on Archetypes found on maps.
Definition: AbstractGameObject.java:20
net
net.sf.gridarta.commands.Collector.start
void start()
Starts collecting.
Definition: Collector.java:86
net.sf.gridarta.model.resource.AbstractResources.canWriteCollected
boolean canWriteCollected()
Whether the resources can be written in collected form.
Definition: AbstractResources.java:119
net.sf.gridarta.model.resource.AbstractResources
Maintains resources.
Definition: AbstractResources.java:40
net.sf.gridarta.action.CollectArchesAction
An EditorAction that runs the archetype collection.
Definition: CollectArchesAction.java:51
net.sf.gridarta.action.CollectArchesAction.CollectArchesAction
CollectArchesAction(@NotNull final ProjectSettings projectSettings, @NotNull final AbstractResources< G, A, R > resources, @NotNull final Exiter exiter, @NotNull final JFrame parent)
Creates a new instance.
Definition: CollectArchesAction.java:104
net.sf.gridarta.model.maparchobject.MapArchObject
Interface for MapArchObjects.
Definition: MapArchObject.java:40
net.sf.gridarta.action.CollectArchesAction.doCollectArches
boolean doCollectArches(final boolean performAction)
Executes the "collect arches" action.
Definition: CollectArchesAction.java:130
net.sf.gridarta.utils.ActionBuilderUtils.getString
static String getString(@NotNull final ActionBuilder actionBuilder, @NotNull final String key, @NotNull final String defaultValue)
Returns the value of a key.
Definition: ActionBuilderUtils.java:71
net.sf.gridarta.model.resource
Definition: AbstractCollectedResourcesReader.java:20
net.sf.gridarta.action.CollectArchesAction.collector
volatile Collector collector
The Collector if an archetype collection is running, or else.
Definition: CollectArchesAction.java:88
net.sf.gridarta.model.settings.ProjectSettings
Settings that apply to a project.
Definition: ProjectSettings.java:29
net.sf.gridarta.commands
Definition: BatchPngCommand.java:20
net.sf.gridarta.action.CollectArchesAction.ACTION_BUILDER
static final ActionBuilder ACTION_BUILDER
Action Builder to create Actions.
Definition: CollectArchesAction.java:57
net.sf.gridarta.model
net.sf.gridarta.model.archetype.Archetype
Reflects an Archetype.
Definition: Archetype.java:41
net.sf.gridarta.gui.utils.AsynchronousProgress
Implements a Progress that forwards to another.
Definition: AsynchronousProgress.java:33
net.sf.gridarta.model.settings.ProjectSettings.getCollectedDirectory
File getCollectedDirectory()
Returns the directory where collected archetypes are stored.
net.sf.gridarta.utils.ActionBuilderUtils
Utility class for ActionBuilder related functions.
Definition: ActionBuilderUtils.java:31
net.sf.gridarta.action.CollectArchesAction.parent
final JFrame parent
The parent component for dialog windows.
Definition: CollectArchesAction.java:81
net.sf.gridarta.model.maparchobject
Definition: AbstractMapArchObject.java:20
net.sf.gridarta.gui.utils
Definition: AnimationComponent.java:20
net.sf.gridarta.action.CollectArchesAction.resources
final AbstractResources< G, A, R > resources
The AbstractResources to collect.
Definition: CollectArchesAction.java:75
net.sf.gridarta.utils.EditorAction
A global editor action.
Definition: EditorAction.java:29
net.sf.gridarta.utils.ExiterListener
Interface for listeners interested in Exiter related events.
Definition: ExiterListener.java:28
net.sf.gridarta.utils
Definition: ActionBuilderUtils.java:20
net.sf.gridarta.model.settings
Definition: AbstractDefaultProjectSettings.java:20
net.sf.gridarta.action.CollectArchesAction.action
Action action
The action associated with this editor action.
Definition: CollectArchesAction.java:95
net.sf.gridarta.utils.Exiter
Exits the application.
Definition: Exiter.java:28