View Javadoc

1   /*
2    * ModeShape (http://www.modeshape.org)
3    * See the COPYRIGHT.txt file distributed with this work for information
4    * regarding copyright ownership.  Some portions may be licensed
5    * to Red Hat, Inc. under one or more contributor license agreements.
6    * See the AUTHORS.txt file in the distribution for a full listing of 
7    * individual contributors. 
8    *
9    * ModeShape is free software. Unless otherwise indicated, all code in ModeShape
10   * is licensed to you under the terms of the GNU Lesser General Public License as
11   * published by the Free Software Foundation; either version 2.1 of
12   * the License, or (at your option) any later version.
13   *
14   * ModeShape is distributed in the hope that it will be useful,
15   * but WITHOUT ANY WARRANTY; without even the implied warranty of
16   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17   * Lesser General Public License for more details.
18   *
19   * You should have received a copy of the GNU Lesser General Public
20   * License along with this software; if not, write to the Free
21   * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
22   * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
23   */
24  package org.modeshape.common.collection;
25  
26  import java.util.Iterator;
27  import java.util.LinkedList;
28  import java.util.List;
29  import net.jcip.annotations.NotThreadSafe;
30  
31  /**
32   * A simple {@link Problems} collection. The problems will be {@link #iterator() returned} in the order in which they were
33   * encountered (although this cannot be guaranteed in contexts involving multiple threads or processes).
34   */
35  @NotThreadSafe
36  public class SimpleProblems extends AbstractProblems {
37      private static final long serialVersionUID = 1L;
38  
39      private List<Problem> problems;
40  
41      /**
42       * {@inheritDoc}
43       * 
44       * @see org.modeshape.common.collection.AbstractProblems#addProblem(Problem)
45       */
46      @Override
47      protected void addProblem( Problem problem ) {
48          if (problem == null) return;
49          if (problems == null) problems = new LinkedList<Problem>();
50          problems.add(problem);
51      }
52  
53      /**
54       * {@inheritDoc}
55       * 
56       * @see org.modeshape.common.collection.AbstractProblems#getProblems()
57       */
58      @Override
59      protected List<Problem> getProblems() {
60          return this.problems != null ? problems : EMPTY_PROBLEMS;
61      }
62  
63      /**
64       * {@inheritDoc}
65       * 
66       * @see java.lang.Object#toString()
67       */
68      @Override
69      public String toString() {
70          StringBuilder sb = new StringBuilder();
71          Iterator<Problem> iter = getProblems().iterator();
72          if (iter.hasNext()) {
73              sb.append(iter.next());
74              while (iter.hasNext()) {
75                  sb.append("\n");
76                  sb.append(iter.next());
77              }
78          }
79          return sb.toString();
80      }
81  }