blob: 597a69b57c66765301f5553482bcfc1b1c6114db (
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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
/*******************************************************************************
* Copyright (c) 2007, 2008 IBM Corporation and others.
* 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:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.equinox.internal.provisional.p2.core.repository;
import java.net.URL;
import java.util.Map;
import org.eclipse.core.runtime.IAdaptable;
/**
* Base interface that defines common properties that may be provided by
* various kinds of repositories.
* <p>
* This interface is not intended to be implemented by clients.
*/
public interface IRepository extends IAdaptable {
/**
* The property key for a boolean property indicating that the repository
* is a system repository. System repositories are implementation details
* that are not subject to general access, hidden from the typical user, etc.
*/
static public String PROP_SYSTEM = "p2.system"; //$NON-NLS-1$
/**
* The key for a boolean property indicating that repository metadata is
* stored in compressed form. A compressed repository will have lower
* bandwidth cost to read when remote, but higher processing cost to
* uncompress when reading.
*/
public static final String PROP_COMPRESSED = "p2.compressed"; //$NON-NLS-1$
/**
* Returns the URL of the repository.
* TODO: Should we use URL or URI? URL requires a protocol handler
* to be installed in Java. Can the URL have any protocol?
* @return the URL of the repository.
*/
public URL getLocation();
/**
* Returns the name of the repository.
* @return the name of the repository.
*/
public String getName();
/**
* Returns a string representing the type of the repository.
* @return the type of the repository.
*/
public String getType();
/**
* Returns a string representing the version for the repository type.
* @return the version of the type of the repository.
*/
public String getVersion();
/**
* Returns a brief description of the repository.
* @return the description of the repository.
*/
public String getDescription();
/**
* Returns the name of the provider of the repository.
* @return the provider of this repository.
*/
public String getProvider();
/**
* Returns a read-only collection of the properties of the repository.
* @return the properties of this repository.
*/
public Map getProperties();
/**
* Returns <code>true</code> if this repository can be modified.
* @return whether or not this repository can be modified
*/
public boolean isModifiable();
/**
* Set the name of the repository.
*/
public void setName(String name);
/**
* Sets the description of the repository.
*/
public void setDescription(String description);
/**
* Sets the value of the property with the given key. Returns the old property
* associated with that key, if any. Setting a value of <code>null</code> will
* remove the corresponding key from the properties of this repository.
*
* @param key The property key
* @param value The new property value, or <code>null</code> to remove the key
* @return The old property value, or <code>null</code> if there was no old value
*/
public String setProperty(String key, String value);
/**
* Sets the name of the provider of the repository.
*/
public void setProvider(String provider);
}
|