1 /*

     2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     3  *

     4  * This code is free software; you can redistribute it and/or modify it

     5  * under the terms of the GNU General Public License version 2 only, as

     6  * published by the Free Software Foundation.  Sun designates this

     7  * particular file as subject to the "Classpath" exception as provided

     8  * by Sun in the LICENSE file that accompanied this code.

     9  *

    10  * This code is distributed in the hope that it will be useful, but WITHOUT

    11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    13  * version 2 for more details (a copy is included in the LICENSE file that

    14  * accompanied this code).

    15  *

    16  * You should have received a copy of the GNU General Public License version

    17  * 2 along with this work; if not, write to the Free Software Foundation,

    18  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    19  *

    20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

    21  * CA 95054 USA or visit www.sun.com if you need additional information or

    22  * have any questions.

    23  */

    24 

    25 /*

    26  * This file is available under and governed by the GNU General Public

    27  * License version 2 only, as published by the Free Software Foundation.

    28  * However, the following notice accompanied the original version of this

    29  * file and, per its terms, should not be removed:

    30  *

    31  * Copyright (c) 2004 World Wide Web Consortium,

    32  *

    33  * (Massachusetts Institute of Technology, European Research Consortium for

    34  * Informatics and Mathematics, Keio University). All Rights Reserved. This

    35  * work is distributed under the W3C(r) Software License [1] in the hope that

    36  * it will be useful, but WITHOUT ANY WARRANTY; without even the implied

    37  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

    38  *

    39  * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231

    40  */

    41 

    42 package org.w3c.dom.ls;

    43 

    44 import org.w3c.dom.events.Event;

    45 

    46 /**

    47  *  This interface represents a progress event object that notifies the

    48  * application about progress as a document is parsed. It extends the

    49  * <code>Event</code> interface defined in [<a href='http://www.w3.org/TR/2003/NOTE-DOM-Level-3-Events-20031107'>DOM Level 3 Events</a>]

    50  * .

    51  * <p> The units used for the attributes <code>position</code> and

    52  * <code>totalSize</code> are not specified and can be implementation and

    53  * input dependent.

    54  * <p>See also the <a href='http://www.w3.org/TR/2004/REC-DOM-Level-3-LS-20040407'>Document Object Model (DOM) Level 3 Load

    55 and Save Specification</a>.

    56  */

    57 public interface LSProgressEvent extends Event {

    58     /**

    59      * The input source that is being parsed.

    60      */

    61     public LSInput getInput();

    62 

    63     /**

    64      * The current position in the input source, including all external

    65      * entities and other resources that have been read.

    66      */

    67     public int getPosition();

    68 

    69     /**

    70      * The total size of the document including all external resources, this

    71      * number might change as a document is being parsed if references to

    72      * more external resources are seen. A value of <code>0</code> is

    73      * returned if the total size cannot be determined or estimated.

    74      */

    75     public int getTotalSize();

    76 

    77 }