View Javadoc

1   /*
2    * Copyright (c) 2009-2012 The 99 Software Foundation
3    *
4    * Permission is hereby granted, free of charge, to any person obtaining a copy
5    * of this software and associated documentation files (the "Software"), to deal
6    * in the Software without restriction, including without limitation the rights
7    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    * copies of the Software, and to permit persons to whom the Software is
9    * furnished to do so, subject to the following conditions:
10   *
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20   * THE SOFTWARE.
21   */
22  package org.nnsoft.sameas4j;
23  
24  import java.util.ArrayList;
25  import java.util.Iterator;
26  import java.util.List;
27  
28  /**
29   * Represents an {@link Equivalence} list.
30   */
31  public final class EquivalenceList implements Iterable<Equivalence> {
32  
33      /**
34       * The {@link Equivalence} list.
35       */
36      private final List<Equivalence> equivalenceList = new ArrayList<Equivalence>();
37  
38      /**
39       * Add a new {@link Equivalence} into the list.
40       *
41       * @param equivalence the {@link Equivalence} has to be added into the list.
42       */
43      protected void addEquivalence(Equivalence equivalence) {
44          this.equivalenceList.add(equivalence);
45      }
46  
47      /**
48       * {@inheritDoc}
49       */
50      public Iterator<Equivalence> iterator() {
51          return equivalenceList.iterator();
52      }
53  
54      /**
55       * Return the number of {@link Equivalence} found.
56       *
57       * @return the number of {@link Equivalence} found.
58       */
59      public int size() {
60          return this.equivalenceList.size();
61      }
62  
63      /**
64       * {@inheritDoc}
65       */
66      @Override
67      public String toString() {
68          return this.equivalenceList.toString();
69      }
70  
71  }