Gridarta Editor
DefaultErrorCollector.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.model.validation;
21 
22 import java.util.ArrayList;
23 import java.util.Collections;
24 import java.util.Iterator;
25 import java.util.List;
30 import org.jetbrains.annotations.NotNull;
31 
37 public class DefaultErrorCollector<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> implements ErrorCollector<G, A, R>, Iterable<ValidationError<G, A, R>> {
38 
42  private static final long serialVersionUID = 1L;
43 
47  @NotNull
48  private final List<ValidationError<G, A, R>> errors = new ArrayList<>();
49 
53  private boolean sorted = true;
54 
55  @Override
56  public void collect(@NotNull final ValidationError<G, A, R> error) {
57  errors.add(error);
58  sorted = false;
59  }
60 
61  @NotNull
62  @Override
63  public Iterator<ValidationError<G, A, R>> iterator() {
64  if (!sorted) {
65  sorted = true;
67  }
68  return Collections.unmodifiableList(errors).iterator();
69  }
70 
71  @NotNull
72  @Override
73  public Iterable<ValidationError<G, A, R>> getErrors() {
74  return this;
75  }
76 
77 }
net.sf.gridarta
Base package of all Gridarta classes.
net.sf.gridarta.model.validation.errors.ValidationError
Super class of all errors that could occur during map validation.
Definition: ValidationError.java:45
net.sf.gridarta.model.validation.DefaultErrorCollector.iterator
Iterator< ValidationError< G, A, R > > iterator()
Definition: DefaultErrorCollector.java:63
net.sf
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.model.gameobject
GameObjects are the objects based on Archetypes found on maps.
Definition: AbstractGameObject.java:20
net
net.sf.gridarta.model.maparchobject.MapArchObject
Interface for MapArchObjects.
Definition: MapArchObject.java:40
net.sf.gridarta.model.validation.DefaultErrorCollector.errors
final List< ValidationError< G, A, R > > errors
Errors.
Definition: DefaultErrorCollector.java:48
net.sf.gridarta.model.validation.ValidationErrorComparator
A Comparator that compares ValidationError instances for display ordering.
Definition: ValidationErrorComparator.java:37
net.sf.gridarta.model.validation.DefaultErrorCollector.serialVersionUID
static final long serialVersionUID
The serial version UID.
Definition: DefaultErrorCollector.java:42
net.sf.gridarta.model.validation.ErrorCollector
An interface for classes that collect errors.
Definition: ErrorCollector.java:33
net.sf.gridarta.model.validation.DefaultErrorCollector.getErrors
Iterable< ValidationError< G, A, R > > getErrors()
Definition: DefaultErrorCollector.java:73
net.sf.gridarta.model.validation.DefaultErrorCollector.sorted
boolean sorted
Whether errors is sorted.
Definition: DefaultErrorCollector.java:53
net.sf.gridarta.model.validation
This package contains the framework for validating maps.
Definition: AbstractValidator.java:20
net.sf.gridarta.model
net.sf.gridarta.model.archetype.Archetype
Reflects an Archetype.
Definition: Archetype.java:41
net.sf.gridarta.model.validation.errors
Definition: AttributeRangeError.java:20
net.sf.gridarta.model.validation.DefaultErrorCollector
Simple error collector that just collects the error in a collection for later retrieval through itera...
Definition: DefaultErrorCollector.java:37
net.sf.gridarta.model.maparchobject
Definition: AbstractMapArchObject.java:20
net.sf.gridarta.model.validation.DefaultErrorCollector.collect
void collect(@NotNull final ValidationError< G, A, R > error)
Definition: DefaultErrorCollector.java:56