Add transientRegion property to ProtectedRegion as a flag to only be stored in memory and not saved (#355)

worldguard-legacy/src/main/java/com/sk89q/worldguard/protection/managers/RegionManager.java

@@ -105,7 +105,7 @@ public void load() throws StorageException {
      */
     public void save() throws StorageException {
         index.setDirty(false);
-        store.saveAll(new HashSet<ProtectedRegion>(getValuesCopy()));
+        store.saveAll(new HashSet<ProtectedRegion>(getFilteredValuesCopy()));
     }
 
     /**
@@ -422,12 +422,18 @@ public boolean apply(ProtectedRegion test) {
     }
 
     /**
-     * Get an {@link ArrayList} copy of regions in the index.
+     * Get an {@link ArrayList} copy of regions in the index with transient regions filtered.
      *
      * @return a list
      */
-    private List<ProtectedRegion> getValuesCopy() {
+    private List<ProtectedRegion> getFilteredValuesCopy() {
-        return new ArrayList<ProtectedRegion>(index.values());
+        List<ProtectedRegion> filteredValues = new ArrayList<ProtectedRegion>();
+        for (ProtectedRegion region : index.values()) {
+            if (!region.isTransient()) {
+                filteredValues.add(region);
+            }
+        }
+        return filteredValues;
     }
 
     // =============== HELPER METHODS ===============

worldguard-legacy/src/main/java/com/sk89q/worldguard/protection/regions/GlobalProtectedRegion.java

@@ -39,12 +39,24 @@
 public class GlobalProtectedRegion extends ProtectedRegion {
 
     /**
-     * Create a new instance.
+     * Create a new instance.<br>
+     * Equivalent to {@link #GlobalProtectedRegion(String, boolean) GlobalProtectedRegion(id, false)}<br>
+     * <code>transientRegion</code> will be set to false, and this region can be saved.
      *
      * @param id the ID
      */
     public GlobalProtectedRegion(String id) {
-        super(id);
+        this(id, false);
+    }
+
+    /**
+     * Create a new instance.
+     *
+     * @param id the ID
+     * @param transientRegion whether this region should only be kept in memory and not be saved
+     */
+    public GlobalProtectedRegion(String id, boolean transientRegion) {
+        super(id, transientRegion);
         min = new BlockVector(0, 0, 0);
         max = new BlockVector(0, 0, 0);
     }

worldguard-legacy/src/main/java/com/sk89q/worldguard/protection/regions/ProtectedCuboidRegion.java

@@ -39,14 +39,29 @@
 public class ProtectedCuboidRegion extends ProtectedRegion {
 
     /**
-     * Construct a new instance of this cuboid region.
+     * Construct a new instance of this cuboid region.<br>
+     * Equivalent to {@link #ProtectedCuboidRegion(String, boolean, BlockVector, BlockVector)
+     * ProtectedCuboidRegion(id, false, pt1, pt2)}<br>
+     * <code>transientRegion</code> will be set to false, and this region can be saved.
      *
      * @param id the region id
      * @param pt1 the first point of this region
      * @param pt2 the second point of this region
      */
     public ProtectedCuboidRegion(String id, BlockVector pt1, BlockVector pt2) {
-        super(id);
+        this(id, false, pt1, pt2);
+    }
+
+    /**
+     * Construct a new instance of this cuboid region.
+     *
+     * @param id the region id
+     * @param transientRegion whether this region should only be kept in memory and not be saved
+     * @param pt1 the first point of this region
+     * @param pt2 the second point of this region
+     */
+    public ProtectedCuboidRegion(String id, boolean transientRegion, BlockVector pt1, BlockVector pt2) {
+        super(id, transientRegion);
         setMinMaxPoints(pt1, pt2);
     }
 

worldguard-legacy/src/main/java/com/sk89q/worldguard/protection/regions/ProtectedPolygonalRegion.java

@@ -36,8 +36,32 @@ public class ProtectedPolygonalRegion extends ProtectedRegion {
     private final int minY;
     private final int maxY;
 
+    /**
+     * Construct a new instance of this polygonal region.<br>
+     * Equivalent to {@link #ProtectedPolygonalRegion(String, boolean, List, int, int)
+     * ProtectedPolygonalRegion(id, false, points, minY, maxY)}<br>
+     * <code>transientRegion</code> will be set to false, and this region can be saved.
+     *
+     * @param id the region id
+     * @param points a {@link List} of points that this region should contain
+     * @param minY the minimum y coordinate
+     * @param maxY the maximum y coordinate
+     */
     public ProtectedPolygonalRegion(String id, List<BlockVector2D> points, int minY, int maxY) {
-        super(id);
+        this(id, false, points, minY, maxY);
+    }
+
+    /**
+     * Construct a new instance of this polygonal region.
+     *
+     * @param id the region id
+     * @param transientRegion whether this region should only be kept in memory and not be saved
+     * @param points a {@link List} of points that this region should contain
+     * @param minY the minimum y coordinate
+     * @param maxY the maximum y coordinate
+     */
+    public ProtectedPolygonalRegion(String id, boolean transientRegion, List<BlockVector2D> points, int minY, int maxY) {
+        super(id, transientRegion);
         ImmutableList<BlockVector2D> immutablePoints = ImmutableList.copyOf(points);
         setMinMaxPoints(immutablePoints, minY, maxY);
         this.points = immutablePoints;

worldguard-legacy/src/main/java/com/sk89q/worldguard/protection/regions/ProtectedRegion.java

@@ -56,6 +56,7 @@ public abstract class ProtectedRegion implements ChangeTracked, Comparable<Prote
     protected BlockVector max;
 
     private final String id;
+    private final boolean transientRegion;
     private int priority = 0;
     private ProtectedRegion parent;
     private DefaultDomain owners = new DefaultDomain();
@@ -67,9 +68,10 @@ public abstract class ProtectedRegion implements ChangeTracked, Comparable<Prote
      * Construct a new instance of this region.
      *
      * @param id the name of this region
+     * @param transientRegion whether this region should only be kept in memory and not be saved
      * @throws IllegalArgumentException thrown if the ID is invalid (see {@link #isValidId(String)}
      */
-    ProtectedRegion(String id) { // Package private because we can't have people creating their own region types
+    ProtectedRegion(String id, boolean transientRegion) { // Package private because we can't have people creating their own region types
         checkNotNull(id);
 
         if (!isValidId(id)) {
@@ -77,6 +79,7 @@ public abstract class ProtectedRegion implements ChangeTracked, Comparable<Prote
         }
 
         this.id = Normal.normalize(id);
+        this.transientRegion = transientRegion;
     }
 
     /**
@@ -680,8 +683,21 @@ protected boolean intersectsEdges(ProtectedRegion region) {
      */
     abstract Area toArea();
 
+    /**
+     * @return <code>true</code> if this region should only be kept in memory and not be saved
+     */
+    public boolean isTransient() {
+        return transientRegion;
+    }
+
+    /**
+     * @return <code>true</code> if this region is not transient and changes have been made.
+     */
     @Override
     public boolean isDirty() {
+        if (isTransient()) {
+            return false;
+        }
         return dirty || owners.isDirty() || members.isDirty();
     }