1 /*

     2  * Copyright (c) 2005, 2011, 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 /*

    26  * $Id: NodeSetData.java,v 1.5 2005/05/10 15:47:42 mullan Exp $

    27  */

    28 package javax.xml.crypto;

    29 

    30 import java.util.Iterator;

    31 

    32 /**

    33  * An abstract representation of a <code>Data</code> type containing a

    34  * node-set. The type (class) and ordering of the nodes contained in the set

    35  * are not defined by this class; instead that behavior should be

    36  * defined by <code>NodeSetData</code> subclasses.

    37  *

    38  * @author Sean Mullan

    39  * @author JSR 105 Expert Group

    40  * @since 1.6

    41  */

    42 public interface NodeSetData extends Data {

    43 

    44     /**

    45      * Returns a read-only iterator over the nodes contained in this

    46      * <code>NodeSetData</code> in

    47      * <a href="http://www.w3.org/TR/1999/REC-xpath-19991116#dt-document-order">

    48      * document order</a>. Attempts to modify the returned iterator

    49      * via the <code>remove</code> method throw

    50      * <code>UnsupportedOperationException</code>.

    51      *

    52      * @return an <code>Iterator</code> over the nodes in this

    53      *    <code>NodeSetData</code> in document order

    54      */

    55     @SuppressWarnings("rawtypes")

    56     Iterator iterator();

    57 }