Skip to main content
summaryrefslogtreecommitdiffstats
blob: ec343a16870a0f0a883693ff782b015a64bd316b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
/*******************************************************************************
 * Copyright (c) 2004, 2007 Boeing.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Boeing - initial API and implementation
 *******************************************************************************/
package org.eclipse.osee.framework.resource.management;

import java.io.InputStream;
import java.net.URI;
import org.eclipse.osee.framework.core.exception.OseeCoreException;

/**
 * @author Roberto E. Escobar
 */
public interface IResource {

   /**
    * Returns an open input stream of the contents of this resource.
    * 
    * @return an input stream containing the contents of this resource
    * @throws OseeCoreException if this method fails.
    */
   public InputStream getContent() throws OseeCoreException;

   /**
    * Returns the absolute URI of this resource, or <code>null</code> if no URI can be determined.
    * 
    * @return the absolute URI of this resource, or <code>null</code> if no URI can be determined
    */
   public URI getLocation();

   /**
    * Get the name of this resource
    * 
    * @return name of this resource
    */
   public String getName();

   /**
    * Whether this resource is compressed or not.
    * 
    * @return <b>true</b> If this resource is compressed. <b>false</b> If this resource is not compressed.
    */
   public boolean isCompressed();

}

Back to the top