← Back to branch summary

~ubuntu-branches/ubuntu/quantal/netbeans/quantal

« back to all changes in this revision

Viewing changes to xml/retriever/src/org/netbeans/modules/xml/retriever/impl/ResourceRetriever.java

  • Committer: Bazaar Package Importer
  • Author(s): Marek Slama
  • Date: 2008-01-29 14:11:22 UTC
  • Revision ID: james.westby@ubuntu.com-20080129141122-fnzjbo11ntghxfu7
Tags: upstream-6.0.1
Import upstream version 6.0.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
xml/retriever/src/org/netbeans/modules/xml/retriever/impl/ResourceRetriever.java
 
1
/*
 
2
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 
3
 *
 
4
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 
5
 *
 
6
 * The contents of this file are subject to the terms of either the GNU
 
7
 * General Public License Version 2 only ("GPL") or the Common
 
8
 * Development and Distribution License("CDDL") (collectively, the
 
9
 * "License"). You may not use this file except in compliance with the
 
10
 * License. You can obtain a copy of the License at
 
11
 * http://www.netbeans.org/cddl-gplv2.html
 
12
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 
13
 * specific language governing permissions and limitations under the
 
14
 * License.  When distributing the software, include this License Header
 
15
 * Notice in each file and include the License file at
 
16
 * nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this
 
17
 * particular file as subject to the "Classpath" exception as provided
 
18
 * by Sun in the GPL Version 2 section of the License file that
 
19
 * accompanied this code. If applicable, add the following below the
 
20
 * License Header, with the fields enclosed by brackets [] replaced by
 
21
 * your own identifying information:
 
22
 * "Portions Copyrighted [year] [name of copyright owner]"
 
23
 *
 
24
 * Contributor(s):
 
25
 *
 
26
 * The Original Software is NetBeans. The Initial Developer of the Original
 
27
 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
 
28
 * Microsystems, Inc. All Rights Reserved.
 
29
 *
 
30
 * If you wish your version of this file to be governed by only the CDDL
 
31
 * or only the GPL Version 2, indicate your decision by adding
 
32
 * "[Contributor] elects to include this software in this distribution
 
33
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 
34
 * single choice of license, a recipient has the option to distribute
 
35
 * your version of this file under either the CDDL, the GPL Version 2 or
 
36
 * to extend the choice of license to its licensees as provided above.
 
37
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 
38
 * Version 2 license, then the option applies only if the new code is
 
39
 * made subject to such option by the copyright holder.
 
40
 */
 
41
 
 
42
/*
 
43
 * ResourceRetriever.java
 
44
 *
 
45
 * Created on January 9, 2006, 2:44 PM
 
46
 *
 
47
 * To change this template, choose Tools | Template Manager
 
48
 * and open the template in the editor.
 
49
 */
 
50
 
 
51
package org.netbeans.modules.xml.retriever.impl;
 
52
 
 
53
import java.io.IOException;
 
54
import java.io.InputStream;
 
55
import java.net.URISyntaxException;
 
56
import java.util.HashMap;
 
57
import org.netbeans.modules.xml.retriever.*;
 
58
 
 
59
/**
 
60
 *
 
61
 * @author girix
 
62
 */
 
63
public interface ResourceRetriever {
 
64
    /**
 
65
     * This method will be called by the factory class. Impl should decide if it supports the protocol
 
66
     * @param baseAddr originating documents address
 
67
     * @param currentAddr address of the document that needs to be fetched - as mentioned in the base document.
 
68
     * @return if impl supports then true else false
 
69
     */
 
70
    public boolean accept(String baseAddr, String currentAddr) throws URISyntaxException;
 
71
    
 
72
    /**
 
73
     * Given the base doc address and the current address (that could be either relative or absoulte), determine the final address to fetch doc and get the stream of that doc.
 
74
     * @param baseAddress address of the base document where the link was found
 
75
     * @param documentAddress current document address as mentioned in the base doc
 
76
     * @return Hash map has the "key" as the final address from where the file was fetched and "value" has the input sream of the file.
 
77
     */
 
78
    public HashMap<String,InputStream> retrieveDocument(
 
79
            String baseAddress, String documentAddress) throws IOException,URISyntaxException;
 
80
    
 
81
    
 
82
     /**
 
83
     * Given the base doc address and the current address (that could be either relative or absoulte), determine the final address to fetch doc and get the stream of that doc.
 
84
     * @param baseAddress address of the base document where the link was found
 
85
     * @param documentAddress current document address as mentioned in the base doc
 
86
     * @return Hash map has the "key" as the final address from where the file was fetched and "value" has the input sream of the file.
 
87
     */
 
88
    public String getEffectiveAddress(
 
89
            String baseAddress, String documentAddress) throws IOException,URISyntaxException;
 
90
    
 
91
    
 
92
    /**
 
93
     * Must be called after retrieveDocument() method. 
 
94
     * This returns the number of chars in the stream. 
 
95
     * Useful for URL retriever where its better to know the length upfront.
 
96
     */
 
97
    public long getStreamLength();
 
98
}