src/main/gov/nasa/jpf/util/ImmutableList.java

   1 /*
   2  * Copyright (C) 2014, United States Government, as represented by the
   3  * Administrator of the National Aeronautics and Space Administration.
   4  * All rights reserved.
   5  *
   6  * The Java Pathfinder core (jpf-core) platform is licensed under the
   7  * Apache License, Version 2.0 (the "License"); you may not use this file except
   8  * in compliance with the License. You may obtain a copy of the License at
   9  *
  10  *        http://www.apache.org/licenses/LICENSE-2.0.
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18 package gov.nasa.jpf.util;
  19
  20 import java.util.Iterator;
  21 import java.util.NoSuchElementException;
  22
  23 /**
  24  * utility class for JPF internal linked lists that are tail-immutable
  25  */
  26 public class ImmutableList<E> implements Iterable<E> {
  27
  28   static class IteratorImpl<E> implements Iterator<E> {
  29
  30     private ImmutableList<E> next;
  31
  32     private IteratorImpl(ImmutableList<E> list){
  33       next = list;
  34     }
  35
  36     @Override
  37         public boolean hasNext() {
  38       return (next != null);
  39     }
  40
  41     @Override
  42         public E next() {
  43       if (next != null){
  44         E elem = next.head;
  45         next = next.tail;
  46         return elem;
  47
  48       } else {
  49         throw new NoSuchElementException();
  50       }
  51     }
  52
  53     @Override
  54         public void remove() {
  55       throw new UnsupportedOperationException("can't remove elements from ImmutableList");
  56     }
  57
  58   }
  59
  60   public final E head;
  61   public final ImmutableList<E> tail;
  62
  63
  64   public ImmutableList(E data, ImmutableList<E> tail) {
  65     this.head = data;
  66     this.tail = tail;
  67   }
  68
  69   @Override
  70   public Iterator<E> iterator() {
  71     return new IteratorImpl(this);
  72   }
  73
  74   public boolean contains (E object){
  75     for (E e : this){
  76       if (e.equals(object)){
  77         return true;
  78       }
  79     }
  80
  81     return false;
  82   }
  83 }