KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > xml > retriever > DocumentTypeParser


1 /*
2  * The contents of this file are subject to the terms of the Common Development
3  * and Distribution License (the License). You may not use this file except in
4  * compliance with the License.
5  *
6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7  * or http://www.netbeans.org/cddl.txt.
8  *
9  * When distributing Covered Code, include this CDDL Header Notice in each file
10  * and include the License file at http://www.netbeans.org/cddl.txt.
11  * If applicable, add the following below the CDDL Header, with the fields
12  * enclosed by brackets [] replaced by your own identifying information:
13  * "Portions Copyrighted [year] [name of copyright owner]"
14  *
15  * The Original Software is NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */

19
20 /*
21  * DocumentTypeParser.java
22  *
23  * Created on January 8, 2006, 2:48 PM
24  *
25  * To change this template, choose Tools | Template Manager
26  * and open the template in the editor.
27  */

28
29 package org.netbeans.modules.xml.retriever;
30
31 import java.io.File JavaDoc;
32 import java.util.List JavaDoc;
33 import org.openide.filesystems.FileObject;
34
35 /**
36  *
37  * @author girix
38  */

39 public interface DocumentTypeParser {
40     
41     /**
42      * will be called by factory to check if the mimeType is accepted by this parser.
43      * @param mimeType MIME type of the current document
44      */

45     boolean accept(String JavaDoc mimeType);
46     /**
47      * this method will be called by the client to get all the external references found in this fileObject.
48      * @param fob FileObject of the file that needs to be pased.
49      */

50     List JavaDoc<String JavaDoc> getAllLocationOfReferencedEntities(FileObject fob) throws Exception JavaDoc;
51     
52     List JavaDoc<String JavaDoc> getAllLocationOfReferencedEntities(File JavaDoc fileToBeParsed) throws Exception JavaDoc;
53 }
54
Popular Tags