< prev index next >

modules/javafx.base/src/main/java/javafx/collections/transformation/TransformationList.java

Print this page
rev 10443 : 8177341: Fix typos in FX API docs
Reviewed-by:
   1 /*
   2  * Copyright (c) 2010, 2016, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 package javafx.collections.transformation;
  26 
  27 import javafx.collections.ListChangeListener.Change;
  28 import java.util.List;
  29 import javafx.collections.ListChangeListener;
  30 import javafx.collections.ObservableList;
  31 import javafx.collections.ObservableListBase;
  32 import javafx.collections.WeakListChangeListener;
  33 
  34 /**
  35  * A base class for all lists that wraps other lists in a way that changes the list's
  36  * elements, order, size or generally it's structure.
  37  *
  38  * If the source list is observable, a listener is automatically added to it
  39  * and the events are delegated to {@link #sourceChanged(javafx.collections.ListChangeListener.Change)}
  40  *
  41  * @param <E> the type parameter of this list
  42  * @param <F> the upper bound of the type of the source list
  43  * @since JavaFX 8.0
  44  */
  45 public abstract class TransformationList<E, F> extends ObservableListBase<E> implements ObservableList<E> {
  46 
  47     /**
  48      * Contains the source list of this transformation list.
  49      * This is never null and should be used to directly access source list content
  50      */
  51     private ObservableList<? extends F> source;
  52     /**
  53      * This field contains the result of expression "source instanceof {@link javafx.collections.ObservableList}".
  54      * If this is true, it is possible to do transforms online.
  55      */
  56     private ListChangeListener<F> sourceListener;


   1 /*
   2  * Copyright (c) 2010, 2017, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 package javafx.collections.transformation;
  26 
  27 import javafx.collections.ListChangeListener.Change;
  28 import java.util.List;
  29 import javafx.collections.ListChangeListener;
  30 import javafx.collections.ObservableList;
  31 import javafx.collections.ObservableListBase;
  32 import javafx.collections.WeakListChangeListener;
  33 
  34 /**
  35  * A base class for all lists that wrap another list in a way that changes
  36  * (transforms) the wrapped list's elements, order, size, or structure.
  37  *
  38  * If the source list is observable, a listener is automatically added to it
  39  * and the events are delegated to {@link #sourceChanged(javafx.collections.ListChangeListener.Change)}
  40  *
  41  * @param <E> the type parameter of this list
  42  * @param <F> the upper bound of the type of the source list
  43  * @since JavaFX 8.0
  44  */
  45 public abstract class TransformationList<E, F> extends ObservableListBase<E> implements ObservableList<E> {
  46 
  47     /**
  48      * Contains the source list of this transformation list.
  49      * This is never null and should be used to directly access source list content
  50      */
  51     private ObservableList<? extends F> source;
  52     /**
  53      * This field contains the result of expression "source instanceof {@link javafx.collections.ObservableList}".
  54      * If this is true, it is possible to do transforms online.
  55      */
  56     private ListChangeListener<F> sourceListener;


< prev index next >